Update paramString for Member descriptions

gselzer · ctrueden · commit 31c983abf1b8 · 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
@@ -382,7 +382,7 @@ private static String paramString(final Iterable<Member<?>> items, final Member<
 
 	/**
 	 * As {@link #paramString(Iterable, Member, String)} with a toggle to
-	 * control if inputs are types only or include the names.
+	 * control if inputs are types only or include the names/descriptions.
 	 */
 	private static String paramString(final Iterable<Member<?>> items, final Member<?> special, final String delim,
 			final boolean typeOnly) {
@@ -401,6 +401,7 @@ private static String paramString(final Iterable<Member<?>> items, final Member<
 
 			if (!typeOnly) {
 				sb.append(" " + item.getKey());
+				sb.append(" -> " + item.getDescription());
 			}
 		}
 		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
@@ -17,6 +17,7 @@
 import org.scijava.ops.OpField;
 import org.scijava.ops.OpInfo;
 import org.scijava.ops.OpMethod;
+import org.scijava.ops.OpUtils;
 import org.scijava.ops.core.Op;
 import org.scijava.ops.core.OpCollection;
 import org.scijava.plugin.Plugin;
@@ -148,6 +149,8 @@ public void opStringRegressionTest() {
 		if (infos.hasNext()) {
 			Assert.fail("Multiple OpInfos with name \"test.javadoc.method\"");
 		}
+
+		// test standard op string
 		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" +
@@ -159,7 +162,16 @@ public void opStringRegressionTest() {
 		String actual = info.toString();
 		Assert.assertEquals(expected, actual);
 
+		// test special op string
+		expected = "(java.util.List<java.lang.Long> output1 -> foo + bar) =\n" +
+			"	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" +
+			"		java.util.List<java.lang.String> foo -> the first input,\n" +
+			"==>		java.util.List<java.lang.String> bar -> the second input)";
+		actual = OpUtils.opString(info, info.inputs().get(1));
+		Assert.assertEquals(expected, actual);
 	}
+
 }
 
 /**

Original file line number	Diff line number	Diff line change
`@@ -382,7 +382,7 @@ private static String paramString(final Iterable<Member<?>> items, final Member<`
`382`	`382`
`383`	`383`	`/**`
`384`	`384`	`* As {@link #paramString(Iterable, Member, String)} with a toggle to`
`385`		`- * control if inputs are types only or include the names.`
	`385`	`+ * control if inputs are types only or include the names/descriptions.`
`386`	`386`	`*/`
`387`	`387`	`private static String paramString(final Iterable<Member<?>> items, final Member<?> special, final String delim,`
`388`	`388`	`final boolean typeOnly) {`
`@@ -401,6 +401,7 @@ private static String paramString(final Iterable<Member<?>> items, final Member<`
`401`	`401`
`402`	`402`	`if (!typeOnly) {`
`403`	`403`	`sb.append(" " + item.getKey());`
	`404`	`+ sb.append(" -> " + item.getDescription());`
`404`	`405`	`}`
`405`	`406`	`}`
`406`	`407`	`return sb.toString();`