diff --git a/core/src/main/java/hudson/search/SearchIndex.java b/core/src/main/java/hudson/search/SearchIndex.java index 886be8474e749c4011d0878092900c63eb49d86d..dc2d7f916ba9890fab19dd6764325007b7547a06 100644 --- a/core/src/main/java/hudson/search/SearchIndex.java +++ b/core/src/main/java/hudson/search/SearchIndex.java @@ -26,7 +26,11 @@ package hudson.search; import java.util.List; /** + * Conceptually a set of {@link SearchItem}s that provide quick look-up + * from their {@linkplain SearchItem#getSearchName() names}. + * * @author Kohsuke Kawaguchi + * @see SearchIndexBuilder */ public interface SearchIndex { void find(String token, List result); diff --git a/core/src/main/java/hudson/search/SearchIndexBuilder.java b/core/src/main/java/hudson/search/SearchIndexBuilder.java index 8f95decf1056f06c190c49b539b501beba477004..b6d2f11f3d149278f2f94203530eb9e6da1b32fb 100644 --- a/core/src/main/java/hudson/search/SearchIndexBuilder.java +++ b/core/src/main/java/hudson/search/SearchIndexBuilder.java @@ -23,11 +23,19 @@ */ package hudson.search; +import hudson.model.AbstractModelObject; + import java.util.ArrayList; import java.util.List; /** + * Builds {@link SearchIndex}. + * + * This object is also used to represent partially build search index, much like {@link StringBuilder} is often + * passed around to cooperatively build search index. + * * @author Kohsuke Kawaguchi + * @see AbstractModelObject#makeSearchIndex() */ public final class SearchIndexBuilder { private final List items = new ArrayList(); diff --git a/core/src/main/java/hudson/search/SearchItem.java b/core/src/main/java/hudson/search/SearchItem.java index 03415be0e2834c224740ab77472e0a4b04f5c738..524d7ea294cd1e7cadf7850f15e1a1b6fc47722d 100644 --- a/core/src/main/java/hudson/search/SearchItem.java +++ b/core/src/main/java/hudson/search/SearchItem.java @@ -57,6 +57,7 @@ public interface SearchItem { * * @return * {@link SearchIndex#EMPTY} if this is a leaf. + * @see SearchIndexBuilder */ SearchIndex getSearchIndex(); }