Package org.jdrupes.mdoclet.internal.doclets.formats.html

Klasse HtmlIndexBuilder

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.util.IndexBuilder

org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlIndexBuilder

public class HtmlIndexBuilder
extends IndexBuilder

Extensions to IndexBuilder to fill in remaining fields in index items: containingModule, containingPackage, containingClass, and url, and to write out the JavaScript files.

Feldübersicht

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.toolkit.util.IndexBuilder

classesOnly

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addElements()	Adds all the selected modules, packages, types and their members to the index, or just the type elements if classesOnly is true.
void	createSearchIndexFiles()	Generates the set of index files used by interactive search.

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.util.IndexBuilder

add, getFirstCharacters, getItems, getItems, getItems, makeGenericSearchIndexComparator, makeTypeSearchIndexComparator

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methodendetails

addElements

public void addElements()

Adds all the selected modules, packages, types and their members to the index, or just the type elements if classesOnly is true.

After the initial work to add the element items, the remaining fields in the items are also initialized.

Setzt außer Kraft:

addElements in Klasse IndexBuilder

createSearchIndexFiles

public void createSearchIndexFiles()
                            throws DocFileIOException

Generates the set of index files used by interactive search.

Löst aus:

DocFileIOException - if there is a problem creating any of the search index files