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

Klasse PackageUseWriter

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.PackageUseWriter

public class PackageUseWriter
extends SubWriterHolderWriter

Generate package 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
PackageUseWriter(HtmlConfiguration configuration, ClassUseMapper mapper, DocPath filename, PackageElement pkgElement)	Constructor.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
protected void	addClassList(Content content)	Add the list of classes that use the given package.
protected void	addPackageList(Content content)	Add the list of packages that use the given package.
protected void	addPackageUse(Content content)	Add the package use information.
static void	generate(HtmlConfiguration configuration, ClassUseMapper mapper, PackageElement pkgElement)	Generate a class page.
protected void	generatePackageUseFile()	Generate the package use list.
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

PackageUseWriter

public PackageUseWriter(HtmlConfiguration configuration,
 ClassUseMapper mapper,
 DocPath filename,
 PackageElement pkgElement)

Constructor.

Parameter:

configuration - the configuration

mapper - a mapper to provide details of where elements are used

filename - the file to be generated

pkgElement - the package element to be documented

Methodendetails

generate

public static void generate(HtmlConfiguration configuration,
 ClassUseMapper mapper,
 PackageElement pkgElement)
                     throws DocFileIOException

Generate a class page.

Parameter:

configuration - the current configuration of the doclet.

mapper - the mapping of the class usage.

pkgElement - the package being documented.

Löst aus:

DocFileIOException - if there is a problem generating the package use page

generatePackageUseFile

protected void generatePackageUseFile()
                               throws DocFileIOException

Generate the package use list.

Löst aus:

DocFileIOException - if there is a problem generating the package use page

addPackageUse

protected void addPackageUse(Content content)

Add the package use information.

Parameter:

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

addPackageList

protected void addPackageList(Content content)

Add the list of packages that use the given package.

Parameter:

content - the content to which the package list will be added

addClassList

protected void addClassList(Content content)

Add the list of classes that use the given package.

Parameter:

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

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