Provide some javadoc to OpMetadata

gselzer · ctrueden · commit 880eca112dea · 2022-07-01T16:21:57.000-05:00
diff --git a/scijava/scijava-ops-api/src/main/java/org/scijava/ops/api/OpMetadata.java b/scijava/scijava-ops-api/src/main/java/org/scijava/ops/api/OpMetadata.java
@@ -2,35 +2,65 @@
 
 import java.lang.reflect.Type;
 
+/**
+ * Container for metadata pertaining to an Op <b>instance</b>. This data is
+ * wrapped up with the Op instance into a {@link RichOp}
+ *
+ * @author Gabriel Selzer
+ * @see RichOp#metadata()
+ */
 public class OpMetadata {
 
+	/* The functional Type of the Op */
 	private final Type type;
+	/* The hierarchy of OpInfos used to make the Op */
 	private final InfoChain info;
+	/* The set of Hints used to in the initial Op call */
 	private final Hints hints;
+	/* The OpHistory used by the Op */
 	private final OpHistory history;
 
-	public OpMetadata(Type type, InfoChain info,
-		Hints hints, OpHistory history)
-	{
+	public OpMetadata(Type type, InfoChain info, Hints hints, OpHistory history) {
 		this.type = type;
 		this.history = history;
 		this.info = info;
 		this.hints = hints;
 	}
 
-	public OpHistory history() {
-		return history;
+	/**
+	 * Gets the functional {@link Type} of the Op
+	 * 
+	 * @return the functional {@link Type} of the Op
+	 */
+	public Type type() {
+		return type;
 	}
 
+	/**
+	 * Gets the hierarchy of {@link OpInfo}s used to make the Op
+	 * 
+	 * @return the hierarchy of {@link OpInfo}s used to make the Op
+	 */
 	public InfoChain info() {
 		return info;
 	}
 
+	/**
+	 * Gets the {@link Hints} used in the initial matcher call
+	 * 
+	 * @return the {@link Hints} used in the initial matcher call
+	 */
 	public Hints hints() {
 		return hints;
 	}
 
-	public Type type() {
-		return type;
+	/**
+	 * Gets the {@link OpHistory} used by this Op
+	 * 
+	 * @return the {@link OpHistory} used by this Op
+	 */
+	public OpHistory history() {
+		return history;
 	}
+
 }
