Add more javadoc

gselzer · ctrueden · commit 68eda09be224 · 2022-07-01T16:25:53.000-05:00
Also, changed the line endings in OpInstance from Windows to Linux.
diff --git a/scijava/scijava-ops-api/src/main/java/org/scijava/ops/api/InfoChain.java b/scijava/scijava-ops-api/src/main/java/org/scijava/ops/api/InfoChain.java
@@ -9,7 +9,7 @@
 
 /**
  * A data structure wrangling a hierarchy of {@link OpInfo}s, created for every
- * Op match and called upon to instantiate any number of Op instances.
+ * Op match and called upon to instantiate any number of {@link OpInstance}s.
  * 
  * This {@link InfoChain} contains:
  * <ol>
diff --git a/scijava/scijava-ops-api/src/main/java/org/scijava/ops/api/OpInstance.java b/scijava/scijava-ops-api/src/main/java/org/scijava/ops/api/OpInstance.java
@@ -1,62 +1,66 @@
-
-package org.scijava.ops.api;
-
-import java.lang.reflect.Type;
-import java.util.Objects;
-
-import org.scijava.types.GenericTyped;
-
-/**
- * An instance of an {@link OpInfo}
- * 
- * @author Gabriel Selzer
- */
-public class OpInstance<T> implements GenericTyped {
-
-	private final T op;
-	private final InfoChain info;
-	private final Type reifiedType;
-
-	public OpInstance(final T op, final InfoChain backingInfo,
-		final Type reifiedType)
-	{
-		this.op = op;
-		this.info = backingInfo;
-		this.reifiedType = reifiedType;
-	}
-
-	public static <T> OpInstance<T> of(T op, InfoChain backingInfo,
-		final Type reifiedType)
-	{
-		return new OpInstance<>(op, backingInfo, reifiedType);
-	}
-
-	public T op() {
-		return op;
-	}
-
-	public InfoChain infoChain() {
-		return info;
-	}
-
-	@Override
-	public boolean equals(Object that) {
-		if (!(that instanceof OpInstance)) return false;
-		OpInstance<?> thatInstance = (OpInstance<?>) that;
-		boolean infosEqual = infoChain().equals(thatInstance.infoChain());
-		boolean objectsEqual = op().equals(thatInstance.op());
-		boolean typesEqual = getType().equals(thatInstance.getType());
-		return infosEqual && objectsEqual && typesEqual;
-	}
-
-	@Override
-	public int hashCode() {
-		return Objects.hash(infoChain(), op(), getType());
-	}
-
-	@Override
-	public Type getType() {
-		return reifiedType;
-	}
-
-}
+
+package org.scijava.ops.api;
+
+import java.lang.reflect.Type;
+import java.util.Objects;
+
+import org.scijava.types.GenericTyped;
+
+/**
+ * An instance of an {@link OpInfo}. They can be constructed directly, but are
+ * easily generated from {@link InfoChain}s.
+ * <p>
+ * Each {@link OpInstance} has an Op and its corresponding {@link OpInfo}.
+ * </p>
+ * 
+ * @author Gabriel Selzer
+ */
+public class OpInstance<T> implements GenericTyped {
+
+	private final T op;
+	private final InfoChain info;
+	private final Type reifiedType;
+
+	public OpInstance(final T op, final InfoChain backingInfo,
+		final Type reifiedType)
+	{
+		this.op = op;
+		this.info = backingInfo;
+		this.reifiedType = reifiedType;
+	}
+
+	public static <T> OpInstance<T> of(T op, InfoChain backingInfo,
+		final Type reifiedType)
+	{
+		return new OpInstance<>(op, backingInfo, reifiedType);
+	}
+
+	public T op() {
+		return op;
+	}
+
+	public InfoChain infoChain() {
+		return info;
+	}
+
+	@Override
+	public boolean equals(Object that) {
+		if (!(that instanceof OpInstance)) return false;
+		OpInstance<?> thatInstance = (OpInstance<?>) that;
+		boolean infosEqual = infoChain().equals(thatInstance.infoChain());
+		boolean objectsEqual = op().equals(thatInstance.op());
+		boolean typesEqual = getType().equals(thatInstance.getType());
+		return infosEqual && objectsEqual && typesEqual;
+	}
+
+	@Override
+	public int hashCode() {
+		return Objects.hash(infoChain(), op(), getType());
+	}
+
+	@Override
+	public Type getType() {
+		return reifiedType;
+	}
+
+}
diff --git a/scijava/scijava-ops-api/src/main/java/org/scijava/ops/api/RichOp.java b/scijava/scijava-ops-api/src/main/java/org/scijava/ops/api/RichOp.java
@@ -7,9 +7,13 @@
 
 /**
  * An {@link OpInstance} with state (i.e. an {@link OpMetadata})
+ * <p>
+ * Each {@link RichOp} has <b>one</b> {@link OpInstance}, and <b>one</b>
+ * {@link OpMetadata}.
+ * </p>
  * 
  * @author Gabriel Selzer
- * @param <T>
+ * @param <T> the functional {@link Type} of the wrapped Op
  */
 public interface RichOp<T> extends GenericTyped {
 

Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`/**`
`11`	`11`	`* A data structure wrangling a hierarchy of {@link OpInfo}s, created for every`
`12`		`- * Op match and called upon to instantiate any number of Op instances.`
	`12`	`+ * Op match and called upon to instantiate any number of {@link OpInstance}s.`
`13`	`13`	`*`
`14`	`14`	`* This {@link InfoChain} contains:`
`15`	`15`	`* <ol>`