From 6c70afa783edf60d99eb0a187ba44006de0e27bb Mon Sep 17 00:00:00 2001
From: Kohsuke Kawaguchi <kk@kohsuke.org>
Date: Tue, 19 Jun 2012 13:54:13 -0700
Subject: [PATCH] doc improvement

---
 core/src/main/java/hudson/search/SearchIndex.java        | 4 ++++
 core/src/main/java/hudson/search/SearchIndexBuilder.java | 8 ++++++++
 core/src/main/java/hudson/search/SearchItem.java         | 1 +
 3 files changed, 13 insertions(+)

diff --git a/core/src/main/java/hudson/search/SearchIndex.java b/core/src/main/java/hudson/search/SearchIndex.java
index 886be8474e..dc2d7f916b 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<SearchItem> result);
diff --git a/core/src/main/java/hudson/search/SearchIndexBuilder.java b/core/src/main/java/hudson/search/SearchIndexBuilder.java
index 8f95decf10..b6d2f11f3d 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<SearchItem> items = new ArrayList<SearchItem>();
diff --git a/core/src/main/java/hudson/search/SearchItem.java b/core/src/main/java/hudson/search/SearchItem.java
index 03415be0e2..524d7ea294 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();
 }
-- 
GitLab