summaryrefslogtreecommitdiff
path: root/base/src/main/java/bjc/utils/funcutils/TreeUtils.java
diff options
context:
space:
mode:
authorbjculkin <bjculkin@mix.wvu.edu>2018-02-12 22:57:29 -0500
committerbjculkin <bjculkin@mix.wvu.edu>2018-02-12 22:57:29 -0500
commit040870eced4dc3e273313b9ec2ce7bb88d9cc6a0 (patch)
tree4712f4fc1dd1c6bccac7a1de98921f78ec6d326a /base/src/main/java/bjc/utils/funcutils/TreeUtils.java
parentdf94066e3af02ff02d5ab4d033a3d603f743234c (diff)
Commenting
Diffstat (limited to 'base/src/main/java/bjc/utils/funcutils/TreeUtils.java')
-rw-r--r--base/src/main/java/bjc/utils/funcutils/TreeUtils.java8
1 files changed, 7 insertions, 1 deletions
diff --git a/base/src/main/java/bjc/utils/funcutils/TreeUtils.java b/base/src/main/java/bjc/utils/funcutils/TreeUtils.java
index 1bdd7b3..ac8bb69 100644
--- a/base/src/main/java/bjc/utils/funcutils/TreeUtils.java
+++ b/base/src/main/java/bjc/utils/funcutils/TreeUtils.java
@@ -13,9 +13,15 @@ import bjc.utils.funcdata.IList;
* @author Benjamin Culkin
*/
public class TreeUtils {
- /*
+ /**
* Convert a tree into a list of outline nodes that match a certain
* path.
+ *
+ * @param tre
+ * The tree to outline.
+ * @param leafMarker
+ * The path to mark nodes with.
+ * @return The list of marked paths.
*/
public static <T> IList<IList<T>> outlineTree(ITree<T> tre, Predicate<T> leafMarker) {
IList<IList<T>> paths = new FunctionalList<>();