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

Klasse TreeWriter

java.lang.Object

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

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

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

public class TreeWriter
extends AbstractTreeWriter

Generate Class Hierarchy page for all the Classes in this run.

Use ClassTree for building the Tree. The name of the generated file is “overview-tree.html” and it is generated in the current or the destination directory.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected BodyContents	bodyContents

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.formats.html.AbstractTreeWriter

classTree

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlDocletWriter

comparators, configuration, contents, docPaths, filename, htmlIds, links, mainBodyScript, messages, options, path, pathToRoot, resources, utils, winTitle

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
TreeWriter(HtmlConfiguration configuration, DocPath filename, ClassTree classTree)	Constructor to construct TreeWriter object.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addPackageTreeLinks(Content content)	Add the links to all the package tree files.
static void	generate(HtmlConfiguration configuration, ClassTree classTree)	Create a TreeWriter object and use it to generate the “overview-tree.html” file.
void	generateTreeFile()	Generate the interface hierarchy and class hierarchy.

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.formats.html.AbstractTreeWriter

addExtendsImplements, addLevelInfo, addPartialInfo, addTree

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.formats.html.HtmlDocletWriter

addInlineComment, addInlineComment, addInlineDeprecatedComment, addPreQualifiedClassLink, addPreQualifiedClassLink, addPreQualifiedStrongClassLink, addPreviewComment, addPreviewInfo, addPreviewSummary, addSrcLink, addSummaryComment, addSummaryComment, addSummaryDeprecatedComment, addTagsInfo, commentTagsToContent, commentTagsToContent, commentTagsToContent, getAnnotations, getBlockTagOutput, getBlockTagOutput, getBody, getBodyStyle, getCrossClassLink, getCrossModuleLink, getCrossPackageLink, getCurrentPageElement, getDeprecatedPhrase, getDocLink, getDocLink, getDocLink, getDocLink, getDocLink, getEnclosingPackageName, getFooter, getHeader, getHeader, getLink, getLocalizedPackageName, getModuleLink, getModuleLink, getNavBar, getNavLinkToOverviewTree, getPackageLabel, getPackageLink, getPackageLink, getPackageTableHeader, getPreQualifiedClassLink, getQualifiedClassLink, getTagletWriterInstance, getTagletWriterInstance, getTypeParameterLinks, getWindowTitle, hasSerializationOverviewTags, invalidTagOutput, pathString, pathString, printHtmlDocument, printHtmlDocument, printHtmlDocument, replaceDocRootDir, resolveExternalSpecURI

Von Klasse geerbte Methoden java.lang.Object

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

Felddetails

bodyContents

protected BodyContents bodyContents

Konstruktordetails

TreeWriter

public TreeWriter(HtmlConfiguration configuration,
 DocPath filename,
 ClassTree classTree)

Constructor to construct TreeWriter object.

Parameter:

configuration - the current configuration of the doclet.

filename - String filename

classTree - the tree being built.

Methodendetails

generate

public static void generate(HtmlConfiguration configuration,
 ClassTree classTree)
                     throws DocFileIOException

Create a TreeWriter object and use it to generate the “overview-tree.html” file.

Parameter:

configuration - the configuration for this doclet

classTree - the class tree being documented.

Löst aus:

DocFileIOException - if there is a problem generating the overview tree page

generateTreeFile

public void generateTreeFile()
                      throws DocFileIOException

Generate the interface hierarchy and class hierarchy.

Löst aus:

DocFileIOException - if there is a problem generating the overview tree page

addPackageTreeLinks

protected void addPackageTreeLinks(Content content)

Add the links to all the package tree files.

Parameter:

content - the content to which the links will be added