Request for changes-123: Improve OTB Applications documentation (part 2)

From OTBWiki
Jump to: navigation, search

[Request for Changes - 123] Improve OTB Applications documentation (part 2)

Status

  • Author: OTB developer team (Julien, Manuel, Victor, Marina, Antoine, Guillaume)
  • Additional Contributors (if different than authors)
  • Submitted on 10.11.2017
  • Proposed target release : 6.4
  • Adopted : +3 from Victor, Julien, Guillaume
  • Merged : bda5a976863c7afbe2a9453956931595dcaf028a

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 ). This is the next step after Request for changes-103: Improve OTB Applications documentation (part 1).

Implementation details

Applications

M       Modules/Applications/AppClassification/app/otbTrainRegression.cxx
M       Modules/Applications/AppClassification/app/otbTrainVectorClassifier.cxx
M       Modules/Applications/AppFiltering/app/otbSmoothing.cxx
M       Modules/Applications/AppHyperspectral/app/otbVertexComponentAnalysis.cxx
M       Modules/Applications/AppImageUtils/app/otbConcatenateImages.cxx
M       Modules/Applications/AppImageUtils/app/otbSplitImage.cxx
M       Modules/Applications/AppImageUtils/app/otbTileFusion.cxx
M       Modules/Applications/AppMorphology/app/otbBinaryMorphologicalOperation.cxx
M       Modules/Applications/AppMorphology/app/otbMorphologicalClassification.cxx
M       Modules/Applications/AppProjection/app/otbConvertCartoToGeoPoint.cxx
M       Modules/Applications/AppProjection/app/otbOrthoRectification.cxx
M       Modules/Applications/AppStereo/app/otbStereoFramework.cxx
M       Modules/Applications/AppStereo/app/otbStereoRectificationGridGenerator.cxx
M       Modules/Applications/AppTextures/app/otbHaralickTextureExtraction.cxx
M       Modules/Applications/AppTextures/app/otbSFSTextureExtraction.cxx
M       Modules/Applications/AppVectorUtils/app/otbConcatenateVectorData.cxx
M       Modules/Applications/AppVectorUtils/app/otbOSMDownloader.cxx
M       Modules/Applications/AppVectorUtils/app/otbVectorDataTransform.cxx

18 applications have been processed during the sprint #2. 

M       Modules/Wrappers/ApplicationEngine/src/otbWrapperMapProjectionParametersHandler.cxx

Documentation of common Map projection parameters has been enhanced. 

M       Modules/Wrappers/CommandLine/src/otbWrapperCommandLineLauncher.cxx

The display of parameters help has been enhanced : 'progress' and 'help' appear at the end, choices are documented.

Tests

Documentation

Additional notes

Retrieved from "https://wiki.orfeo-toolbox.org/index.php?title=Request_for_changes-123:_Improve_OTB_Applications_documentation_(part_2)&oldid=10091"