From de922e69af06a5c12514b528339cb8f159514dcf Mon Sep 17 00:00:00 2001
From: Victor Poughon <victor.poughon@cnes.fr>
Date: Tue, 11 Dec 2018 15:26:30 +0100
Subject: [PATCH] DOC: review long descriptions
---
.../AppClassification/app/otbTrainRegression.cxx | 8 +++++---
.../AppProjection/app/otbVectorDataReprojection.cxx | 10 +++++-----
.../app/otbHooverCompareSegmentation.cxx | 8 ++++----
3 files changed, 14 insertions(+), 12 deletions(-)
diff --git a/Modules/Applications/AppClassification/app/otbTrainRegression.cxx b/Modules/Applications/AppClassification/app/otbTrainRegression.cxx
index 6b980fad7e..a95eb953ca 100644
--- a/Modules/Applications/AppClassification/app/otbTrainRegression.cxx
+++ b/Modules/Applications/AppClassification/app/otbTrainRegression.cxx
@@ -110,15 +110,17 @@ void DoInit() override
"This application trains a classifier from multiple input images or a csv "
"file, in order to perform regression. Predictors are composed of pixel "
"values in each band optionally centered and reduced using an XML "
- "statistics file produced by the ComputeImagesStatistics application.\n "
+ "statistics file produced by the ComputeImagesStatistics application.\n\n"
+
"The output value for each predictor is assumed to be the last band "
"(or the last column for CSV files). Training and validation predictor "
"lists are built such that their size is inferior to maximum bounds given "
"by the user, and the proportion corresponds to the balance parameter. "
"Several classifier parameters can be set depending on the chosen "
"classifier. In the validation process, the mean square error is computed "
- "between the ground truth and the estimated model.\n"
- " This application is based on LibSVM and on OpenCV Machine Learning "
+ "between the ground truth and the estimated model.\n\n"
+
+ "This application is based on LibSVM and on OpenCV Machine Learning "
"classifiers, and is compatible with OpenCV 2.3.1 and later.");
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
diff --git a/Modules/Applications/AppProjection/app/otbVectorDataReprojection.cxx b/Modules/Applications/AppProjection/app/otbVectorDataReprojection.cxx
index 42b7f57d05..6c041b03d0 100644
--- a/Modules/Applications/AppProjection/app/otbVectorDataReprojection.cxx
+++ b/Modules/Applications/AppProjection/app/otbVectorDataReprojection.cxx
@@ -65,11 +65,11 @@ private:
SetName("VectorDataReprojection");
SetDescription("Reproject a vector data using support image projection reference, or a user specified map projection");
SetDocName("Vector Data reprojection");
- std::ostringstream oss;
- oss <<" This application allows reprojecting a vector data using support image projection reference"
- ", or a user given map projection." << std::endl;
- oss <<" If given, image keywordlist can be added to reprojected vectordata.";
- SetDocLongDescription(oss.str());
+
+ SetDocLongDescription(
+ "Reproject vector data using a support image as projection reference or to a user given map projection. "
+ " If given an image keywordlist can be added to the reprojected vectordata.");
+
SetDocLimitations(" ");
SetDocAuthors("OTB-Team");
SetDocSeeAlso(" ");
diff --git a/Modules/Applications/AppSegmentation/app/otbHooverCompareSegmentation.cxx b/Modules/Applications/AppSegmentation/app/otbHooverCompareSegmentation.cxx
index 34d62c2ecb..637110043e 100644
--- a/Modules/Applications/AppSegmentation/app/otbHooverCompareSegmentation.cxx
+++ b/Modules/Applications/AppSegmentation/app/otbHooverCompareSegmentation.cxx
@@ -140,11 +140,11 @@ private:
SetDocLongDescription("This application compares a machine segmentation (MS) with a partial "
"ground truth segmentation (GT). The Hoover metrics are used to estimate "
"scores for correct detection, over-segmentation, under-segmentation and "
- "missed detection."
- "\n The application can output the overall Hoover scores along with colored"
+ "missed detection.\n\n"
+ "The application can output the overall Hoover scores along with colored"
"images of the MS and GT segmentation showing the state of each region "
- "(correct detection, over-segmentation, under-segmentation, missed)"
- "\n The Hoover metrics are described in : Hoover et al., \"An experimental"
+ "(correct detection, over-segmentation, under-segmentation, missed).\n\n"
+ "The Hoover metrics are described in : Hoover et al., \"An experimental"
" comparison of range image segmentation algorithms\", IEEE PAMI vol. 18, no. 7, July 1996.");
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
--
GitLab