Verwendungen von Klasse
org.jdrupes.mdoclet.internal.doclets.toolkit.util.IndexItem

Packages, die IndexItem verwenden

Package	Beschreibung
org.jdrupes.mdoclet.internal.doclets.formats.html	This is the default HTML doclet provided with the JDK.
org.jdrupes.mdoclet.internal.doclets.toolkit.util	This package has utility classes that perform common services required for API documentation generation.

Verwendungen von IndexItem in org.jdrupes.mdoclet.internal.doclets.formats.html

Methoden in org.jdrupes.mdoclet.internal.doclets.formats.html mit Parametern vom Typ IndexItem

Modifizierer und Typ	Methode	Beschreibung
protected void	IndexWriter.addDescription(IndexItem indexItem, Content dl)	Adds the description for an index item into a list.
protected void	IndexWriter.addElementDescription(IndexItem item, Content target)	Add one line summary comment for the item.
protected void	IndexWriter.addTagDescription(IndexItem item, Content target)	Adds a description for an item found in a documentation comment.

Methodenparameter in org.jdrupes.mdoclet.internal.doclets.formats.html mit Typargumenten vom Typ IndexItem

Modifizierer und Typ	Methode	Beschreibung
protected void	IndexWriter.addContents(char ch, SortedSet<IndexItem> items, Content content)	Adds a set of items to the page.

Verwendungen von IndexItem in org.jdrupes.mdoclet.internal.doclets.toolkit.util

Methoden in org.jdrupes.mdoclet.internal.doclets.toolkit.util, die IndexItem zurückgeben

Modifizierer und Typ	Methode	Beschreibung
static IndexItem	IndexItem.of(Element element, DocTree docTree, String label, String holder, String description, DocLink link)	Creates an index item for a node in the doc comment for an element.
static IndexItem	IndexItem.of(ModuleElement moduleElement, Utils utils)	Creates an index item for a module element.
static IndexItem	IndexItem.of(PackageElement packageElement, Utils utils)	Creates an index item for a package element.
static IndexItem	IndexItem.of(TypeElement typeElement, Element member, Utils utils)	Creates an index item for a member element.
static IndexItem	IndexItem.of(TypeElement typeElement, Utils utils)	Creates an index item for a type element.
static IndexItem	IndexItem.of(IndexItem.Category category, String label, DocPath path)	Creates an index item for a summary page, that is not associated with any element or node in a doc comment.
IndexItem	IndexItem.setContainingClass(String c)	Sets the name of the containing class for this item.
IndexItem	IndexItem.setContainingModule(String m)	Sets the name of the containing module for this item.
IndexItem	IndexItem.setContainingPackage(String p)	Sets the name of the containing package for this item.
IndexItem	IndexItem.setUrl(String u)	Sets the URL for the item, when it cannot otherwise be inferred from other fields.

Methoden in org.jdrupes.mdoclet.internal.doclets.toolkit.util, die Typen mit Argumenten vom Typ IndexItem zurückgeben

Modifizierer und Typ	Methode	Beschreibung
SortedSet<IndexItem>	IndexBuilder.getItems(DocTree.Kind kind)	Returns a sorted list of items with a given kind of doc tree.
SortedSet<IndexItem>	IndexBuilder.getItems(Character key)	Returns a sorted list of items whose names start with the provided character.
SortedSet<IndexItem>	IndexBuilder.getItems(IndexItem.Category cat)	Returns a sorted list of items in a given category.
Comparator<IndexItem>	IndexBuilder.makeGenericSearchIndexComparator()	Returns a Comparator for IndexItems in the modules, packages, members, and search tags categories of the search index.
Comparator<IndexItem>	IndexBuilder.makeTypeSearchIndexComparator()	Returns a Comparator for IndexItems in the types category of the search index.

Methoden in org.jdrupes.mdoclet.internal.doclets.toolkit.util mit Parametern vom Typ IndexItem

Modifizierer und Typ	Methode	Beschreibung
void	IndexBuilder.add(IndexItem item)	Adds an individual item to the two collections of items.