Request for changes-103: Improve OTB Applications documentation (part 1)

From OTBWiki
Jump to: navigation, search

[Request for Changes - 103] Improve OTB Applications documentation (part 1)

Status

  • Author: OTB developer team (Julien, Manuel, Marina, Antoine, Guillaume)
  • Additional Contributors (if different than authors)
  • Submitted on 25.07.2017
  • Proposed target release : 6.2
  • Adopted +3 (Victor, Rémi, Guillaume)
  • Merged : 616d922f637146b1bb9b23e6406c7fcbd1745b27

Summary

This RFC improves the quality and amount of documentation in OTB applications.

Rationale

There is an initial RFComments to improve documentation of all OTB applications ( Request_for_Comments-37:_Guidelines_for_Application_documentation )

Implementation details

Applications

M       Modules/Applications/AppFiltering/app/CMakeLists.txt
D       Modules/Applications/AppFiltering/app/otbDespeckle.cxx
M       Modules/Applications/AppFiltering/otb-module.cmake
M       Modules/Applications/AppFiltering/test/CMakeLists.txt
A       Modules/Applications/AppSARUtils/app/otbDespeckle.cxx
M       Modules/Applications/AppSARUtils/otb-module.cmake
M       Modules/Applications/AppSARUtils/test/CMakeLists.txt
M       Modules/Applications/AppSARUtils/app/CMakeLists.txt

The application Despeckle has been moved to module AppSARUtils, and its documentation enhanced. 

M       Modules/Applications/AppChangeDetection/app/otbMultivariateAlterationDetector.cxx
M       Modules/Applications/AppClassification/app/otbComputeImagesStatistics.cxx
M       Modules/Applications/AppClassification/app/otbVectorClassifier.cxx
M       Modules/Applications/AppClassification/include/otbTrainBoost.txx
M       Modules/Applications/AppClassification/include/otbTrainDecisionTree.txx
M       Modules/Applications/AppClassification/include/otbTrainLibSVM.txx
M       Modules/Applications/AppClassification/include/otbTrainNeuralNetwork.txx
M       Modules/Applications/AppClassification/include/otbTrainSVM.txx
M       Modules/Applications/AppClassification/include/otbTrainVectorBase.txx
M       Modules/Applications/AppEdge/app/otbEdgeExtraction.cxx
M       Modules/Applications/AppEdge/app/otbLineSegmentDetection.cxx
M       Modules/Applications/AppHyperspectral/app/otbHyperspectralUnmixing.cxx
M       Modules/Applications/AppMathParser/app/otbBandMath.cxx
M       Modules/Applications/AppMathParserX/app/otbBandMathX.cxx
M       Modules/Applications/AppProjection/app/otbImageEnvelope.cxx
M       Modules/Applications/AppSARCalibration/app/otbSARDeburst.cxx
M       Modules/Applications/AppSARUtils/app/otbComputeModulusAndPhase.cxx
M       Modules/Applications/AppSegmentation/app/otbLSMSSegmentation.cxx
M       Modules/Applications/AppSegmentation/app/otbLSMSSmallRegionsMerging.cxx
M       Modules/Applications/AppSegmentation/app/otbLSMSVectorization.cxx
M       Modules/Applications/AppSegmentation/app/otbMeanShiftSmoothing.cxx
M       Modules/Applications/AppStereo/app/otbBlockMatching.cxx
M       Modules/Applications/AppStereo/app/otbDisparityMapToElevationMap.cxx
M       Modules/Applications/AppStereo/app/otbFineRegistration.cxx
M       Modules/Applications/AppStereo/app/otbGeneratePlyFile.cxx

The documentation of all these applications has been reviewed and enhanced.

For this first sprint : 20 applications done.

Tests

Documentation

M       Documentation/Cookbook/Scripts/otbGenerateWrappersRstDoc.py

Minor fix in a try/catch bloc in the python script generating Rst for applications.

Additional notes

List remaining open issues if any, and additional notes.

Retrieved from "https://wiki.orfeo-toolbox.org/index.php?title=Request_for_changes-103:_Improve_OTB_Applications_documentation_(part_1)&oldid=9752"