Add javadoc to InfoChain

gselzer · ctrueden · commit 8fad709b8440 · 2022-07-01T16:21:57.000-05:00
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,6 +9,18 @@
 
 /**
  * A data structure wrangling a hierarchy of {@link OpInfo}s.
+ * 
+ * This {@link InfoChain} contains:
+ * <ol>
+ * <li>An {@link OpInfo} describing the Op</li>
+ * <li>A {@link List} of {@link OpInfo}s that should be mapped to the Op
+ * dependencies of this Op, <b>in the order that they are presented by the
+ * Op</b>.</li>
+ * </ol>
+ * <p>
+ * This {@link InfoChain} is also able to generate a {@link String} uniquely
+ * identifying itself.
+ * </p>
  *
  * @author Gabriel Selzer
  */
