add javadocs

bldl · Nov 16, 2024 · e40ba30 · e40ba30
1 parent e43a098
commit e40ba30
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/main/java/io/github/bldl/graph/ClassHierarchyGraph.java b/src/main/java/io/github/bldl/graph/ClassHierarchyGraph.java
@@ -60,6 +60,13 @@ public Iterable<T> getVertices() {
         return vertices;
     }
 
+    /**
+     * Determines whether one node is a descendant of another
+     * 
+     * @param ancestor   the presumed ancestor
+     * @param descendant the presumed descendant
+     * @return whether {@code descendant} is a descendant of {@code ancestor}
+     */
     public boolean isDescendant(T ancestor, T descendant) {
         Set<T> visited = new HashSet<>();
         dfs(ancestor, visited);