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

Klasse ClassUseWriter

java.lang.Object

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

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

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

public class ClassUseWriter
extends SubWriterHolderWriter

Generate class usage information.

Feldübersicht

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

bodyContents

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
ClassUseWriter(HtmlConfiguration configuration, ClassUseMapper mapper, DocPath filename, TypeElement typeElement)	Constructor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addClassList(Content content)	Add the class elements that use the given class.
protected void	addClassUse(PackageElement pkg, Content content)	Add the class use information.
protected void	addClassUse(Content content)	Add the class use documentation.
protected void	addPackageAnnotationList(Content content)	Add the package annotation elements.
protected void	addPackageList(Content content)	Add the packages elements that use the given class.
protected void	addPackageUse(PackageElement pkg, Table<?> table)	Add the package use information.
static void	generate(HtmlConfiguration configuration, ClassTree classTree)	Write out class use pages.
static void	generate(HtmlConfiguration configuration, ClassUseMapper mapper, TypeElement typeElement)	Generate a class page.
protected void	generateClassUseFile()	Generate the class use elements.
protected HtmlTree	getClassUseHeader()	Get the header for the class use listing.
protected Navigation	getNavBar(Navigation.PageMode pageMode, Element element)	Returns a basic navigation bar for a kind of page and element.

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

addAnnotationContent, addClassContent, addIndexComment, addIndexComment, addInheritedMemberSummary, addInheritedSummaryHeader, addSummary, addSummaryHeader, addSummaryLinkComment, addSummaryLinkComment, getContentHeader, getDetailsList, getDetailsListItem, getMember, getMember, getMemberDetailsContent, getMemberHeader, getMemberInherited, getMemberList, getMemberListItem, getMemberSummary, getSummariesList, getSummariesListItem

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, 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

Konstruktordetails

ClassUseWriter

public ClassUseWriter(HtmlConfiguration configuration,
 ClassUseMapper mapper,
 DocPath filename,
 TypeElement typeElement)

Constructor.

Parameter:

filename - the file to be generated.

Methodendetails

generate

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

Write out class use pages.

Parameter:

configuration - the configuration for this doclet

classTree - the class tree hierarchy

Löst aus:

DocFileIOException - if there is an error while generating the documentation

generate

public static void generate(HtmlConfiguration configuration,
 ClassUseMapper mapper,
 TypeElement typeElement)
                     throws DocFileIOException

Generate a class page.

Löst aus:

DocFileIOException - if there is a problem while generating the documentation

generateClassUseFile

protected void generateClassUseFile()
                             throws DocFileIOException

Generate the class use elements.

Löst aus:

DocFileIOException - if there is a problem while generating the documentation

addClassUse

protected void addClassUse(Content content)

Add the class use documentation.

Parameter:

content - the content to which the class use information will be added

addPackageList

protected void addPackageList(Content content)

Add the packages elements that use the given class.

Parameter:

content - the content to which the packages elements will be added

addPackageAnnotationList

protected void addPackageAnnotationList(Content content)

Add the package annotation elements.

Parameter:

content - the content to which the package annotation elements will be added

addClassList

protected void addClassList(Content content)

Add the class elements that use the given class.

Parameter:

content - the content to which the class elements will be added

addPackageUse

protected void addPackageUse(PackageElement pkg,
 Table<?> table)

Add the package use information.

Parameter:

pkg - the package that uses the given class

table - the table to which the package use information will be added

addClassUse

protected void addClassUse(PackageElement pkg,
 Content content)

Add the class use information.

Parameter:

pkg - the package that uses the given class

content - the content to which the class use information will be added

getClassUseHeader

protected HtmlTree getClassUseHeader()

Get the header for the class use listing.

Gibt zurück:

the class use header

getNavBar

protected Navigation getNavBar(Navigation.PageMode pageMode,
 Element element)

Beschreibung aus Klasse kopiert: HtmlDocletWriter

Returns a basic navigation bar for a kind of page and element.

Setzt außer Kraft:

getNavBar in Klasse HtmlDocletWriter

Parameter:

pageMode - the page mode

element - the defining element for the navigation bar, or null if none

Gibt zurück:

the basic navigation bar