Clean TODOs, output names

gselzer · ctrueden · commit 8995919455ee · 2021-11-15T17:25:20.000-06:00
diff --git a/scijava/scijava-ops/src/main/java/org/scijava/param/JavadocParameterData.java b/scijava/scijava-ops/src/main/java/org/scijava/param/JavadocParameterData.java
@@ -91,8 +91,6 @@ public JavadocParameterData(Field f) {
 		}
 	}
 
-	// TODO: consider if we want to add more data to the {@link OpInfo}
-	// 
 	public JavadocParameterData(OpInfo info, Type newType) {
 		paramNames = new ArrayList<>();
 		paramDescriptions = new ArrayList<>();
@@ -119,10 +117,8 @@ else if (sam.getParameterCount() < inputs.size()) {
 		}
 		for(Member<?> m : inputs) {
 			paramNames.add(m.getKey());
-			// TODO: Add member support for descriptions
 			paramDescriptions.add(m.getDescription());
 		}
-		// TODO: Add member support for descriptions
 		returnDescription = output.getDescription();
 	}
 
@@ -183,7 +179,7 @@ private void parseMethod(Method m) {
 	public List<Parameter> synthesizeAnnotations(List<FunctionalMethodType> fmts) {
 		List<Parameter> params = new ArrayList<>();
 		int ins = 0;
-		int outs = 1;
+		int outs = 0;
 
 		Map<String, Object> paramValues = new HashMap<>();
 		for (FunctionalMethodType fmt : fmts) {
@@ -200,7 +196,7 @@ public List<Parameter> synthesizeAnnotations(List<FunctionalMethodType> fmts) {
 				break;
 			case OUTPUT:
 				// NB the @return tag does not provide a name, only a comment
-				key = "output" + outs; 
+				key = "output" + (outs == 0 ? "" : outs); 
 				description = returnDescription;
 				outs++;
 				break;
@@ -230,7 +226,6 @@ public List<Parameter> synthesizeAnnotations(List<FunctionalMethodType> fmts) {
 						+ "most likely an implementation error.", e);
 			}
 		}
-		// TODO: consider if some error should be thrown when there are 2+ outputs
 		return params;
 	}
 
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
@@ -65,7 +65,7 @@ public void testJavadocMethod() {
 
 		// assert output name
 		String outputName = info.output().getKey();
-		Assert.assertEquals("output1", outputName);
+		Assert.assertEquals("output", outputName);
 
 		// assert output description
 		String outputDescription = info.output().getDescription();
@@ -103,7 +103,7 @@ public void testJavadocField() {
 
 		// assert output name
 		String outputName = info.output().getKey();
-		Assert.assertEquals("output1", outputName);
+		Assert.assertEquals("output", outputName);
 
 		// assert output description
 		String outputDescription = info.output().getDescription();
@@ -134,7 +134,7 @@ public void testJavadocClass() {
 
 		// assert output name
 		String outputName = info.output().getKey();
-		Assert.assertEquals("output1", outputName);
+		Assert.assertEquals("output", outputName);
 
 		// assert output description
 		String outputDescription = info.output().getDescription();
@@ -158,12 +158,12 @@ public void opStringRegressionTest() {
 				"		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";
+				"		java.util.List<java.lang.Long> output -> foo + bar\n" + ")\n";
 		String actual = info.toString();
 		Assert.assertEquals(expected, actual);
 
 		// test special op string
-		expected = "(java.util.List<java.lang.Long> output1 -> foo + bar) =\n" +
+		expected = "(java.util.List<java.lang.Long> output -> 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" +

Original file line number	Diff line number	Diff line change
`@@ -91,8 +91,6 @@ public JavadocParameterData(Field f) {`
`91`	`91`	`}`
`92`	`92`	`}`
`93`	`93`
`94`		`- // TODO: consider if we want to add more data to the {@link OpInfo}`
`95`		`- //`
`96`	`94`	`public JavadocParameterData(OpInfo info, Type newType) {`
`97`	`95`	`paramNames = new ArrayList<>();`
`98`	`96`	`paramDescriptions = new ArrayList<>();`
`@@ -119,10 +117,8 @@ else if (sam.getParameterCount() < inputs.size()) {`
`119`	`117`	`}`
`120`	`118`	`for(Member<?> m : inputs) {`
`121`	`119`	`paramNames.add(m.getKey());`
`122`		`- // TODO: Add member support for descriptions`
`123`	`120`	`paramDescriptions.add(m.getDescription());`
`124`	`121`	`}`
`125`		`- // TODO: Add member support for descriptions`
`126`	`122`	`returnDescription = output.getDescription();`
`127`	`123`	`}`
`128`	`124`
`@@ -183,7 +179,7 @@ private void parseMethod(Method m) {`
`183`	`179`	`public List<Parameter> synthesizeAnnotations(List<FunctionalMethodType> fmts) {`
`184`	`180`	`List<Parameter> params = new ArrayList<>();`
`185`	`181`	`int ins = 0;`
`186`		`- int outs = 1;`
	`182`	`+ int outs = 0;`
`187`	`183`
`188`	`184`	`Map<String, Object> paramValues = new HashMap<>();`
`189`	`185`	`for (FunctionalMethodType fmt : fmts) {`
`@@ -200,7 +196,7 @@ public List<Parameter> synthesizeAnnotations(List<FunctionalMethodType> fmts) {`
`200`	`196`	`break;`
`201`	`197`	`case OUTPUT:`
`202`	`198`	`// NB the @return tag does not provide a name, only a comment`
`203`		`- key = "output" + outs;`
	`199`	`+ key = "output" + (outs == 0 ? "" : outs);`
`204`	`200`	`description = returnDescription;`
`205`	`201`	`outs++;`
`206`	`202`	`break;`
`@@ -230,7 +226,6 @@ public List<Parameter> synthesizeAnnotations(List<FunctionalMethodType> fmts) {`
`230`	`226`	`+ "most likely an implementation error.", e);`
`231`	`227`	`}`
`232`	`228`	`}`
`233`		`- // TODO: consider if some error should be thrown when there are 2+ outputs`
`234`	`229`	`return params;`
`235`	`230`	`}`
`236`	`231`