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

Klasse ModuleWriterImpl

java.lang.Object

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

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

Alle implementierten Schnittstellen:

ModuleSummaryWriter

public class ModuleWriterImpl
extends HtmlDocletWriter
implements ModuleSummaryWriter

Class to generate file for each module contents in the right-hand frame.

This will list all the required modules, packages and service types for the module. A click on any of the links will update the frame with the clicked element page.

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected ModuleElement	mdle	The module being documented.

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
ModuleWriterImpl(HtmlConfiguration configuration, ModuleElement mdle)	Constructor to construct ModuleWriter object and to generate “moduleName-summary.html” file.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addDeprecationInfo(Content div)	Add the module deprecation information to the documentation tree.
void	addIndirectPackages(Table<?> table, Map<ModuleElement,SortedSet<PackageElement>> ip)	Add the indirect packages for the module being documented.
void	addModuleContent(Content source)	Adds the module content to the documentation.
void	addModuleDescription(Content moduleContent)	Adds the module description.
void	addModuleFooter()	Adds the footer to the documentation.
void	addModuleSignature(Content moduleContent)	Adds the module signature.
void	addModulesSummary(Content summariesList)	Adds the summary of modules to the list of summaries.
void	addPackageDeprecationInfo(Content li, PackageElement pkg)	Add the module package deprecation information to the documentation tree.
void	addPackagesSummary(Content summariesList)	Adds the summary of packages to the list of summaries.
void	addPackageSummary(HtmlTree li)	Add the package summary for the module.
void	addProvidesList(Table<?> table)	Add the provides list for the module.
void	addServicesSummary(Content summariesList)	Adds the summary of services to the list of summaries.
void	addSummaryHeader(Content startMarker, Content heading, Content target)	Add the summary header.
void	addUsesList(Table<?> table)	Add the uses list for the module.
void	computeModulesData()	Compute the modules data that will be displayed in various tables on the module summary page.
boolean	display(Map<? extends Element,?> section)	Returns true if there are elements to be displayed.
boolean	display(Set<? extends Element> section)	Returns true if there are elements to be displayed.
Content	getContentHeader()	Get the header for the module content.
Content	getModuleHeader(String heading)	Get the header for the summary.
protected Navigation	getNavBar(Navigation.PageMode pageMode, Element element)	Returns a basic navigation bar for a kind of page and element.
Content	getSummariesList()	Get the header for the summary header.
Content	getSummary(Content source)	Wrap the content into summary section.
void	printDocument(Content content)	Print the module summary document.
boolean	shouldDocument(Element element)	Returns true if the element should be documented on the module summary page.

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

Felddetails

mdle

protected ModuleElement mdle

The module being documented.

Konstruktordetails

ModuleWriterImpl

public ModuleWriterImpl(HtmlConfiguration configuration,
 ModuleElement mdle)

Constructor to construct ModuleWriter object and to generate “moduleName-summary.html” file.

Parameter:

configuration - the configuration of the doclet.

mdle - Module under consideration.

Methodendetails

getModuleHeader

public Content getModuleHeader(String heading)

Beschreibung aus Schnittstelle kopiert: ModuleSummaryWriter

Get the header for the summary.

Angegeben von:

getModuleHeader in Schnittstelle ModuleSummaryWriter

Parameter:

heading - module name.

Gibt zurück:

the header to be added to the content

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

getContentHeader

public Content getContentHeader()

Beschreibung aus Schnittstelle kopiert: ModuleSummaryWriter

Get the header for the module content.

Angegeben von:

getContentHeader in Schnittstelle ModuleSummaryWriter

Gibt zurück:

the module content header

getSummariesList

public Content getSummariesList()

Beschreibung aus Schnittstelle kopiert: ModuleSummaryWriter

Get the header for the summary header.

Angegeben von:

getSummariesList in Schnittstelle ModuleSummaryWriter

Gibt zurück:

the summary header

getSummary

public Content getSummary(Content source)

Beschreibung aus Schnittstelle kopiert: ModuleSummaryWriter

Wrap the content into summary section.

Angegeben von:

getSummary in Schnittstelle ModuleSummaryWriter

Parameter:

source - the content to wrap into the summary section

Gibt zurück:

the summary

computeModulesData

public void computeModulesData()

Compute the modules data that will be displayed in various tables on the module summary page.

shouldDocument

public boolean shouldDocument(Element element)

Returns true if the element should be documented on the module summary page.

Parameter:

element - the element to be checked

Gibt zurück:

true if the element should be documented

display

public boolean display(Set<? extends Element> section)

Returns true if there are elements to be displayed.

Parameter:

section - set of elements

Gibt zurück:

true if there are elements to be displayed

display

public boolean display(Map<? extends Element,?> section)

Returns true if there are elements to be displayed.

Parameter:

section - map of elements.

Gibt zurück:

true if there are elements to be displayed

addSummaryHeader

public void addSummaryHeader(Content startMarker,
 Content heading,
 Content target)

Add the summary header.

Parameter:

startMarker - the marker comment

heading - the heading for the section

target - the content to which the information is added

addModulesSummary

public void addModulesSummary(Content summariesList)

Beschreibung aus Schnittstelle kopiert: ModuleSummaryWriter

Adds the summary of modules to the list of summaries.

Angegeben von:

addModulesSummary in Schnittstelle ModuleSummaryWriter

Parameter:

summariesList - the list of summaries

addPackagesSummary

public void addPackagesSummary(Content summariesList)

Beschreibung aus Schnittstelle kopiert: ModuleSummaryWriter

Adds the summary of packages to the list of summaries.

Angegeben von:

addPackagesSummary in Schnittstelle ModuleSummaryWriter

Parameter:

summariesList - the list of summaries

addPackageSummary

public void addPackageSummary(HtmlTree li)

Add the package summary for the module.

Parameter:

li -

addIndirectPackages

public void addIndirectPackages(Table<?> table,
 Map<ModuleElement,SortedSet<PackageElement>> ip)

Add the indirect packages for the module being documented.

Parameter:

table - the table to which the content rows will be added

ip - indirect packages to be added

addServicesSummary

public void addServicesSummary(Content summariesList)

Beschreibung aus Schnittstelle kopiert: ModuleSummaryWriter

Adds the summary of services to the list of summaries.

Angegeben von:

addServicesSummary in Schnittstelle ModuleSummaryWriter

Parameter:

summariesList - the list of summaries

addUsesList

public void addUsesList(Table<?> table)

Add the uses list for the module.

Parameter:

table - the table to which the services used will be added

addProvidesList

public void addProvidesList(Table<?> table)

Add the provides list for the module.

Parameter:

table - the table to which the services provided will be added

addDeprecationInfo

public void addDeprecationInfo(Content div)

Add the module deprecation information to the documentation tree.

Parameter:

div - the content to which the deprecation information will be added

addModuleDescription

public void addModuleDescription(Content moduleContent)

Beschreibung aus Schnittstelle kopiert: ModuleSummaryWriter

Adds the module description.

Angegeben von:

addModuleDescription in Schnittstelle ModuleSummaryWriter

Parameter:

moduleContent - the content to which the module description will be added

addModuleSignature

public void addModuleSignature(Content moduleContent)

Beschreibung aus Schnittstelle kopiert: ModuleSummaryWriter

Adds the module signature.

Angegeben von:

addModuleSignature in Schnittstelle ModuleSummaryWriter

Parameter:

moduleContent - the content to which the module signature will be added

addModuleContent

public void addModuleContent(Content source)

Beschreibung aus Schnittstelle kopiert: ModuleSummaryWriter

Adds the module content to the documentation.

Angegeben von:

addModuleContent in Schnittstelle ModuleSummaryWriter

Parameter:

source - the content that will be added

addModuleFooter

public void addModuleFooter()

Beschreibung aus Schnittstelle kopiert: ModuleSummaryWriter

Adds the footer to the documentation.

Angegeben von:

addModuleFooter in Schnittstelle ModuleSummaryWriter

printDocument

public void printDocument(Content content)
                   throws DocFileIOException

Beschreibung aus Schnittstelle kopiert: ModuleSummaryWriter

Print the module summary document.

Angegeben von:

printDocument in Schnittstelle ModuleSummaryWriter

Parameter:

content - the content that will be printed

Löst aus:

DocFileIOException - if there is a problem while writing the document

addPackageDeprecationInfo

public void addPackageDeprecationInfo(Content li,
 PackageElement pkg)

Add the module package deprecation information to the documentation tree.

Parameter:

li - the content to which the deprecation information will be added

pkg - the PackageDoc that is added