Skip to content

Commit c89546b

Browse files
ctruedengselzer
authored andcommitted
Fix OpEnvironment javadoc errors
1 parent 520610f commit c89546b

File tree

1 file changed

+7
-16
lines changed

1 file changed

+7
-16
lines changed

scijava-ops-api/src/main/java/org/scijava/ops/api/OpEnvironment.java

Lines changed: 7 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -214,8 +214,9 @@ InfoTree treeFromInfo(final OpInfo info, final Nil<?> specialType,
214214
* Entry point for convenient Op calls, providing a builder-style interface to
215215
* walk through the process step-by-step.
216216
* </p>
217-
* <br/>
217+
* <p>
218218
* The general order of specification:
219+
* </p>
219220
* <ol>
220221
* <li>The op name (and {@link Hints}, if desired)</li>
221222
* <li>The number of input(s)</li>
@@ -237,9 +238,9 @@ InfoTree treeFromInfo(final OpInfo info, final Nil<?> specialType,
237238
* <li>Inputs with no output &rarr; <code>Inplace</code> or
238239
* <code>Function</code> with unknown (<code>Object</code>) return</li>
239240
* </ul>
240-
* <br/>
241241
* <p>
242242
* Examples: {@code OpEnvironment env = new DefaultOpEnvironment();}
243+
* </p>
243244
* <ul>
244245
* <li>{@code env.op("create").outType(DoubleType.class).create();} &#8212;
245246
* run an Op creating an instance of the ImgLib2 {@code DoubleType}</li>
@@ -266,16 +267,11 @@ InfoTree treeFromInfo(final OpInfo info, final Nil<?> specialType,
266267
* <li>{@code env.op("filter.addPoissonNoise").input(img1).mutate();} &#8212;
267268
* run an Op adding poisson noise to an input image.</li>
268269
* </ul>
269-
* </p>
270270
*
271271
* @param opName The name of the Op to run
272272
* @return The {@link OpBuilder} instance for builder chaining.
273-
* @throws org.scijava.ops.api.OpMatchingException if the Op request cannot be
274-
* satisfied
275-
* @see <a href="#op-java.lang.String-org.scijava.ops.api.Hints-"
276-
* title="To specify a Hints instance to use">op(String, Hints)</a>
277-
* @see <a href="#nullary-java.lang.String-"
278-
* title="For a series of convenience builds with arity pre-selected">nullary(String)</a>
273+
* @throws OpMatchingException if the Op request cannot be satisfied
274+
* @see #op(String, Hints) To specify a Hints instance to use
279275
* @see OpBuilder
280276
*/
281277
default OpBuilder op(final String opName) {
@@ -288,13 +284,8 @@ default OpBuilder op(final String opName) {
288284
* @param opName The name of the Op to run
289285
* @param hints The {@code Hints} instance to use for Op matching
290286
* @return The {@link OpBuilder} instance for builder chaining.
291-
* @throws org.scijava.ops.api.OpMatchingException if the Op request cannot be
292-
* satisfied
293-
* @see <a href="#op-java.lang.String-"
294-
* title="To use the default Hints for this OpEnvironment">op(String)</a>
295-
* @see <a href="#nullary-java.lang.String-org.scijava.ops.api.Hints-"
296-
* title="For a series of convenience builds with arity pre-selected">nullary(String,
297-
* Hints)</a>
287+
* @throws OpMatchingException if the Op request cannot be satisfied
288+
* @see #op(String) To use the default Hints for this OpEnvironment
298289
*/
299290
default OpBuilder op(final String opName, final Hints hints) {
300291
return new OpBuilder(this, opName, hints);

0 commit comments

Comments
 (0)