Add descriptions to OpString

gselzer · ctrueden · commit 77c31dea20ed · 2021-11-15T17:25:20.000-06:00
diff --git a/scijava/scijava-ops/src/main/java/org/scijava/ops/OpUtils.java b/scijava/scijava-ops/src/main/java/org/scijava/ops/OpUtils.java
@@ -414,6 +414,10 @@ public static String opString(final OpInfo info) {
 			sb.append(arg.getType().getTypeName());
 			sb.append(" ");
 			sb.append(arg.getKey());
+			if (!arg.getDescription().isEmpty()) {
+				sb.append(" -> ");
+				sb.append(arg.getDescription());
+			}
 			sb.append("\n");
 		}
 		sb.append("\t Outputs:\n");
@@ -422,6 +426,10 @@ public static String opString(final OpInfo info) {
 		sb.append(arg.getType().getTypeName());
 		sb.append(" ");
 		sb.append(arg.getKey());
+		if (!arg.getDescription().isEmpty()) {
+			sb.append(" -> ");
+			sb.append(arg.getDescription());
+		}
 		sb.append("\n");
 		sb.append(")\n");
 		return sb.toString();
diff --git a/scijava/scijava-ops/src/test/java/org/scijava/param/JavadocParameterTest.java b/scijava/scijava-ops/src/test/java/org/scijava/param/JavadocParameterTest.java
@@ -140,6 +140,26 @@ public void testJavadocClass() {
 		Assert.assertEquals("the output", outputDescription);
 	}
 
+	@Test
+	public void opStringRegressionTest() {
+		Iterator<OpInfo> infos = ops.env().infos("test.javadoc.method").iterator();
+
+		OpInfo info = infos.next();
+		if (infos.hasNext()) {
+			Assert.fail("Multiple OpInfos with name \"test.javadoc.method\"");
+		}
+		String expected =
+			"public static java.util.List<java.lang.Long> org.scijava.param.JavadocParameterTest." +
+				"OpMethodFoo(java.util.List<java.lang.String>,java.util.List<java.lang.String>)(\n" +
+				"	 Inputs:\n" +
+				"		java.util.List<java.lang.String> foo -> the first input\n" +
+				"		java.util.List<java.lang.String> bar -> the second input\n" +
+				"	 Outputs:\n" +
+				"		java.util.List<java.lang.Long> output1 -> foo + bar\n" + ")\n";
+		String actual = info.toString();
+		Assert.assertEquals(expected, actual);
+
+	}
 }
 
 /**
