提交 6c70afa7 编写于 作者: K Kohsuke Kawaguchi

doc improvement

上级 f49d6258
...@@ -26,7 +26,11 @@ package hudson.search; ...@@ -26,7 +26,11 @@ package hudson.search;
import java.util.List; 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 * @author Kohsuke Kawaguchi
* @see SearchIndexBuilder
*/ */
public interface SearchIndex { public interface SearchIndex {
void find(String token, List<SearchItem> result); void find(String token, List<SearchItem> result);
......
...@@ -23,11 +23,19 @@ ...@@ -23,11 +23,19 @@
*/ */
package hudson.search; package hudson.search;
import hudson.model.AbstractModelObject;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; 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 * @author Kohsuke Kawaguchi
* @see AbstractModelObject#makeSearchIndex()
*/ */
public final class SearchIndexBuilder { public final class SearchIndexBuilder {
private final List<SearchItem> items = new ArrayList<SearchItem>(); private final List<SearchItem> items = new ArrayList<SearchItem>();
......
...@@ -57,6 +57,7 @@ public interface SearchItem { ...@@ -57,6 +57,7 @@ public interface SearchItem {
* *
* @return * @return
* {@link SearchIndex#EMPTY} if this is a leaf. * {@link SearchIndex#EMPTY} if this is a leaf.
* @see SearchIndexBuilder
*/ */
SearchIndex getSearchIndex(); SearchIndex getSearchIndex();
} }
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册