Update user guide and javadocs

prdoyle · Nov 22, 2024 · 0f29c85 · 0f29c85
1 parent 616921f
commit 0f29c85
Show file tree

Hide file tree

Showing 2 changed files with 85 additions and 52 deletions.
diff --git a/bosk-core/src/main/java/works/bosk/Bosk.java b/bosk-core/src/main/java/works/bosk/Bosk.java
@@ -1208,10 +1208,18 @@ public NonexistentEntryException(Path path) {
 		}
 	}
 
+	/**
+	 * Equivalent to {@code rootReference().buildReferences(refsClass)}.
+	 *
+	 * @see RootReference#buildReferences
+	 */
 	public final <T> T buildReferences(Class<T> refsClass) throws InvalidTypeException {
 		return rootReference().buildReferences(refsClass);
 	}
 
+	/**
+	 * @return a {@link RootReference} whose {@link Reference#path path} is {@link Path#isEmpty empty}.
+	 */
 	public final RootReference<R> rootReference() {
 		return rootRef;
 	}