[SNAP-793] Links to external pages in classifier help don't work and …

…several other formatting issues in html help files (cherry picked from commit 4f9b8c5)
senbox-org · Mar 16, 2023 · 5f616a0 · 5f616a0
1 parent 74574b2
commit 5f616a0
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/snap-binning/src/main/java/org/esa/snap/binning/operator/BinningOp.java b/snap-binning/src/main/java/org/esa/snap/binning/operator/BinningOp.java
@@ -218,7 +218,7 @@ public enum TimeFilterMethod {
     private ProductCustomizerConfig productCustomizerConfig;
 
     @Parameter(description = "If true, a SeaDAS-style, binned data NetCDF file is written in addition to the\n" +
-                             "target product. The output file name will be <target>-bins.nc",
+            "target product. The output file name will be {target}-bins.nc",
             defaultValue = "false")
     private boolean outputBinnedData;
 

diff --git a/snap-gpf/src/main/java/org/esa/snap/core/gpf/common/ReadOp.java b/snap-gpf/src/main/java/org/esa/snap/core/gpf/common/ReadOp.java
@@ -40,7 +40,7 @@
 import org.esa.snap.core.util.converters.RectangleConverter;
 import org.locationtech.jts.geom.Geometry;
 
-import java.awt.*;
+import java.awt.Rectangle;
 import java.io.File;
 import java.io.IOException;
 import java.util.Arrays;
@@ -86,14 +86,14 @@ public class ReadOp extends Operator {
 
     @Parameter(converter = RectangleConverter.class,
             description = "The subset region in pixel coordinates.\n" +
-                    "Use the following format: <x>,<y>,<width>,<height>\n" +
+                    "Use the following format: {x>,{y>,{width>,{height>\n" +
                     "If not given, the entire scene is used. The 'geoRegion' parameter has precedence over this parameter.")
     private Rectangle pixelRegion;
 
     @Parameter(converter = JtsGeometryConverter.class,
             description = "The subset region in geographical coordinates using WKT-format,\n" +
-                    "e.g. POLYGON((<lon1> <lat1>, <lon2> <lat2>, ..., <lon1> <lat1>))\n" +
-                    "(make sure to quote the option due to spaces in <geometry>).\n" +
+                    "e.g. POLYGON(({lon1} {lat1}, {lon2} {lat2}, ..., {lon1} {lat1}))\n" +
+                    "(make sure to quote the option due to spaces in {geometry}).\n" +
                     "If not given, the entire scene is used.")
     private Geometry geometryRegion;
 

diff --git a/snap-gpf/src/main/java/org/esa/snap/core/gpf/common/SubsetOp.java b/snap-gpf/src/main/java/org/esa/snap/core/gpf/common/SubsetOp.java
@@ -86,7 +86,7 @@ public class SubsetOp extends Operator {
 
     @Parameter(converter = RectangleConverter.class,
             description = "The subset region in pixel coordinates.\n" +
-                    "Use the following format: <x>,<y>,<width>,<height>\n" +
+                    "Use the following format: {x},{y},{width},{height}\n" +
                     "If not given, the entire scene is used. The 'geoRegion' parameter has precedence over this parameter.")
     private Rectangle region = null;
 
@@ -96,9 +96,9 @@ public class SubsetOp extends Operator {
 
     @Parameter(converter = JtsGeometryConverter.class,
             description = "The subset region in geographical coordinates using WKT-format,\n" +
-                          "e.g. POLYGON((<lon1> <lat1>, <lon2> <lat2>, ..., <lon1> <lat1>))\n" +
-                          "(make sure to quote the option due to spaces in <geometry>).\n" +
-                          "If not given, the entire scene is used.")
+                    "e.g. POLYGON(({lon1} {lat1}, {lon2} {lat2}, ..., {lon1} {lat1}))\n" +
+                    "(make sure to quote the option due to spaces in {geometry}).\n" +
+                    "If not given, the entire scene is used.")
     private Geometry geoRegion;
     @Parameter(defaultValue = "1",
             description = "The pixel sub-sampling step in X (horizontal image direction)")