Commit 51bc360b authored by Luc Hermitte's avatar Luc Hermitte

DOC: Fix missing doc examples

parent bd044664
......@@ -53,7 +53,7 @@ private:
{
SetName("ClampROI");
SetDescription("This is the ClampROI application, version X.X.X");
SetDescription("This is the ClampROI application");
SetDocLongDescription(
"This application is similar to ExtractROI in the sense it extracts a Region of Interrest.\n"
"However, the region outside of the ROI isn't trimmed, but set to 0.\n"
......@@ -64,7 +64,7 @@ private:
SetDocLimitations("This application only works on scalar (and complex) images.");
SetDocAuthors("Luc Hermitte (CS Group)");
SetDocSeeAlso("ManageNoData, ExtractROI");
AddDocTag("otb::Wrapper::Tags::Manip");
AddDocTag(Tags::Manip);
AddParameter(ParameterType_InputImage, "in", "Input image");
SetParameterDescription("in", "Scalar Input image");
......@@ -88,7 +88,18 @@ private:
SetParameterDescription("threshold.y.end", "Bottom line index threshold");
SetDefaultParameterInt("threshold.y.end", 0);
SetMinimumParameterIntValue("threshold.x", 0);
SetMinimumParameterIntValue("threshold.y.start", 0);
SetMinimumParameterIntValue("threshold.y.end", 0);
AddRAMParameter();
SetDocExampleParameterValue("in", "ClampROIInput100x100.tiff");
SetDocExampleParameterValue("threshold.x", "10");
SetDocExampleParameterValue("threshold.y.start", "12");
SetDocExampleParameterValue("threshold.y.end", "25");
SetDocExampleParameterValue("out", "ClampROI.tiff");
SetOfficialDocLink();
}
void DoUpdateParameters() override
......
......@@ -60,14 +60,14 @@ private:
{
SetName("Synthetize");
SetDescription("This is the Synthetize application, version X.X.X");
SetDescription("This is the Synthetize application");
SetDocLongDescription("Concatenate a list of images of the same size into a single single-channel image.\n\
It keeps the first non-null pixel value found in the input list.");
SetDocLimitations("This application will break incoming pipelines.");
SetDocAuthors("Luc Hermitte (CS Group)");
SetDocSeeAlso("");
AddDocTag("otb::Wrapper::Tags::Manip");
AddDocTag(Tags::Manip);
AddParameter(ParameterType_StringList, "il", "Input images list");
SetParameterDescription("il", "Input image list");
......@@ -76,6 +76,10 @@ private:
SetParameterDescription("out","Output image.");
AddRAMParameter();
SetDocExampleParameterValue("il", "s1a_33NWB_vv_DES_007_20200108t044150.tif s1a_33NWB_vv_DES_007_20200108t044215.tif");
SetDocExampleParameterValue("out", "s1a_33NWB_vv_DES_007_20200108txxxxxx.tif");
SetOfficialDocLink();
}
void DoUpdateParameters() override
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment