From 140b9036e9bb584c6033c7f740f69fd5ece08177 Mon Sep 17 00:00:00 2001
From: Victor Poughon <victor.poughon@cnes.fr>
Date: Fri, 21 Dec 2018 12:17:47 +0100
Subject: [PATCH] DOC: cookbook formatting
---
.../app/otbMultivariateAlterationDetector.cxx | 9 +++++----
.../app/otbKMeansClassification.cxx | 5 ++---
.../app/otbMorphologicalProfilesAnalysis.cxx | 2 +-
.../AppSegmentation/app/otbLSMSSegmentation.cxx | 2 +-
.../AppSegmentation/app/otbLargeScaleMeanShift.cxx | 14 +++++++-------
.../AppStereo/app/otbGeneratePlyFile.cxx | 11 ++++++-----
6 files changed, 22 insertions(+), 21 deletions(-)
diff --git a/Modules/Applications/AppChangeDetection/app/otbMultivariateAlterationDetector.cxx b/Modules/Applications/AppChangeDetection/app/otbMultivariateAlterationDetector.cxx
index 27813b1dde..339c94e979 100644
--- a/Modules/Applications/AppChangeDetection/app/otbMultivariateAlterationDetector.cxx
+++ b/Modules/Applications/AppChangeDetection/app/otbMultivariateAlterationDetector.cxx
@@ -55,12 +55,13 @@ private:
" algorithm.\n\n"
"The MAD algorithm produces a set of N change maps (where N is the"
" maximum number of bands in first and second input images), with the"
- " following properties:\n"
- " - Change maps are differences of a pair of linear combinations of "
+ " following properties:\n\n"
+
+ "* Change maps are differences of a pair of linear combinations of "
" bands from image 1 and bands from image 2 chosen to maximize the "
" correlation, \n"
- " - Each change map is orthogonal to the others.\n"
- " \n"
+ "* Each change map is orthogonal to the others.\n\n"
+
"This is a statistical method which can handle different modalities"
" and even different bands and number of bands between images. \n"
" \n"
diff --git a/Modules/Applications/AppClassification/app/otbKMeansClassification.cxx b/Modules/Applications/AppClassification/app/otbKMeansClassification.cxx
index 813db65bcb..dc59be6383 100644
--- a/Modules/Applications/AppClassification/app/otbKMeansClassification.cxx
+++ b/Modules/Applications/AppClassification/app/otbKMeansClassification.cxx
@@ -404,10 +404,9 @@ private:
SetDocName("Unsupervised KMeans image classification");
SetDocLongDescription("Unsupervised KMeans image classification. "
- "KMeansClassification is a composite application, "
- "using an existing training and classification application. "
+ "This is a composite application, using existing training and classification applications. "
"The SharkKMeans model is used.\n\n"
- "KMeansClassification application is only available if OTB is compiled with Shark support"
+ "This application is only available if OTB is compiled with Shark support"
"(CMake option :code:`OTB_USE_SHARK=ON`).\n\n"
"The steps of this composite application:\n\n"
diff --git a/Modules/Applications/AppMorphology/app/otbMorphologicalProfilesAnalysis.cxx b/Modules/Applications/AppMorphology/app/otbMorphologicalProfilesAnalysis.cxx
index 64afbb3e4d..ae3c31abac 100644
--- a/Modules/Applications/AppMorphology/app/otbMorphologicalProfilesAnalysis.cxx
+++ b/Modules/Applications/AppMorphology/app/otbMorphologicalProfilesAnalysis.cxx
@@ -85,7 +85,7 @@ private:
"IEEE Transactions on geoscience and remote sensing, vol. 39, NO. 2,\n"
"February 2001, p. 309-320.\n\n"
- "Depending of the profile selection, the application provides::\n\n"
+ "Depending of the profile selection, the application provides:\n\n"
"* The multi scale geodesic morphological opening or closing profile of the input image.\n"
"* The multi scale derivative of the opening or closing profile.\n"
diff --git a/Modules/Applications/AppSegmentation/app/otbLSMSSegmentation.cxx b/Modules/Applications/AppSegmentation/app/otbLSMSSegmentation.cxx
index 44056bd97c..ec561e7213 100644
--- a/Modules/Applications/AppSegmentation/app/otbLSMSSegmentation.cxx
+++ b/Modules/Applications/AppSegmentation/app/otbLSMSSegmentation.cxx
@@ -243,7 +243,7 @@ private:
"Please also note that the output image type should be set to uint32 to"
" ensure that there are enough labels available.\n\n"
"The output of this application can be passed to the"
- " LSMSSmallRegionMerging [3] or LSMSVectorization [4] applications to"
+ " LSMSSmallRegionsMerging [3] or LSMSVectorization [4] applications to"
" complete the LSMS workflow.");
SetDocLimitations("This application is part of the Large-Scale Mean-Shift segmentation"
" workflow (LSMS) [1] and may not be suited for any other purpose. This"
diff --git a/Modules/Applications/AppSegmentation/app/otbLargeScaleMeanShift.cxx b/Modules/Applications/AppSegmentation/app/otbLargeScaleMeanShift.cxx
index 9d11b93046..5f0aa2b53b 100644
--- a/Modules/Applications/AppSegmentation/app/otbLargeScaleMeanShift.cxx
+++ b/Modules/Applications/AppSegmentation/app/otbLargeScaleMeanShift.cxx
@@ -58,9 +58,9 @@ private:
// Documentation
SetDocName("Large-Scale MeanShift");
SetDocLongDescription("This application chains together the 4 steps of the "
- "MeanShit framework, that is the MeanShiftSmoothing [1], the "
- "LSMSSegmentation [2], the LSMSSmallRegionsMerging [3] and the "
- "LSMSVectorization [4].\n\n"
+ "MeanShit framework, that is the MeanShiftSmoothing, the "
+ "LSMSSegmentation, the LSMSSmallRegionsMerging and the "
+ "LSMSVectorization.\n\n"
"This application can be a preliminary step for an object-based analysis.\n\n"
"It generates a vector data file containing the regions extracted with "
"the MeanShift algorithm. The spatial and range radius parameters allow "
@@ -75,10 +75,10 @@ private:
);
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
- SetDocSeeAlso("[1] MeanShiftSmoothing\n"
- "[2] LSMSSegmentation\n"
- "[3] LSMSSmallRegionsMerging\n"
- "[4] LSMSVectorization");
+ SetDocSeeAlso("MeanShiftSmoothing\n"
+ "LSMSSegmentation\n"
+ "LSMSSmallRegionsMerging\n"
+ "LSMSVectorization");
AddDocTag(Tags::Segmentation);
AddDocTag("LSMS");
diff --git a/Modules/Applications/AppStereo/app/otbGeneratePlyFile.cxx b/Modules/Applications/AppStereo/app/otbGeneratePlyFile.cxx
index d1fbc1895f..8fc318b9d1 100644
--- a/Modules/Applications/AppStereo/app/otbGeneratePlyFile.cxx
+++ b/Modules/Applications/AppStereo/app/otbGeneratePlyFile.cxx
@@ -64,13 +64,14 @@ private:
" or CloudCompare [3]\n\n"
"This application is part of the stereo reconstruction framework. The "
"input data can be produced by the application DisparityMapToElevationMap.\n\n"
- "There are two types of supported input images:\n"
- " * A DEM image, with a ground projection, containing elevation values. "
+ "There are two types of supported input images:\n\n"
+
+ "* A DEM image, with a ground projection, containing elevation values. "
"Each elevation value can be considered as a 3D point.\n"
- " * A 3D grid image, containing 5 bands (the first 3 are the 3D "
+ "* A 3D grid image, containing 5 bands (the first 3 are the 3D "
"coordinates of each point, the 5th is a validity mask where valid values"
- " are larger or equal to 1)\n"
- "\n"
+ " are larger or equal to 1)\n\n"
+
"The user shall also give a support image that contains color values for"
" each 3D point. The color values will be embedded in the PLY file.");
SetDocLimitations("The input DEM image has to entirely fit into memory.");
--
GitLab