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

Klasse EnumConstantWriterImpl

java.lang.Object

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

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

Alle implementierten Schnittstellen:

EnumConstantWriter, MemberSummaryWriter, MemberWriter

public class EnumConstantWriterImpl
extends AbstractMemberWriter
implements EnumConstantWriter, MemberSummaryWriter

Writes enum constant documentation in HTML format.

Feldübersicht

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

configuration, contents, htmlIds, links, options, resources, typeElement, utils, writer

Konstruktorübersicht

Konstruktoren

Konstruktor	Beschreibung
EnumConstantWriterImpl(SubWriterHolderWriter writer)
EnumConstantWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addComments(VariableElement enumConstant, Content enumConstants)	Add the comments for the given enum constant.
void	addDeprecated(VariableElement enumConstant, Content content)	Add the deprecated output for the given enum constant.
void	addInheritedSummaryLabel(TypeElement typeElement, Content content)	Adds inherited summary label for the member.
protected void	addInheritedSummaryLink(TypeElement typeElement, Element member, Content target)	Adds the inherited summary link for the member.
void	addPreview(VariableElement enumConstant, Content content)	Add the preview output for the given member.
void	addSummary(Content summariesList, Content content)	Adds the given summary to the list of summaries.
void	addSummaryLabel(Content content)	Adds the summary label for the member.
protected void	addSummaryLink(HtmlLinkInfo.Kind context, TypeElement typeElement, Element member, Content content)	Adds the summary link for the member.
protected void	addSummaryType(Element member, Content content)	Adds the summary type for the member.
void	addTags(VariableElement enumConstant, Content content)	Add the tags for the given enum constant.
protected Table<Element>	createSummaryTable()	Creates the summary table for this element.
Content	getEnumConstantsDetails(Content memberDetailsHeader, Content content)	Get the enum constants details.
Content	getEnumConstantsDetailsHeader(TypeElement typeElement, Content memberDetails)	Get the enum constants details header.
Content	getEnumConstantsHeader(VariableElement enumConstant, Content enumConstantsDetails)	Get the enum constants documentation header.
Content	getMemberHeader()	Gets the member header.
Content	getMemberSummaryHeader(TypeElement typeElement, Content content)	Returns the member summary header for the given class.
Content	getSignature(VariableElement enumConstant)	Get the signature for the given enum constant.
protected Content	getSummaryLink(Element member)	Returns a link for summary (deprecated, preview) pages.
TableHeader	getSummaryTableHeader(Element member)	Returns the summary table header for the member.

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

addComment, addDeprecatedInfo, addInheritedMemberSummary, addMemberSummary, addModifiersAndType, addPreviewInfo, addSummaryLink, addUseInfo, getInheritedSummaryHeader, getInheritedSummaryLinks, getMember, getMemberList, getMemberListItem, getSummaryTable, name, serialWarning

Von Klasse geerbte Methoden java.lang.Object

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

Von Schnittstelle geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.MemberSummaryWriter

addInheritedMemberSummary, addMemberSummary, getInheritedSummaryHeader, getInheritedSummaryLinks, getMember, getSummaryTable

Von Schnittstelle geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.MemberWriter

getMemberList, getMemberListItem

Konstruktordetails

EnumConstantWriterImpl

public EnumConstantWriterImpl(SubWriterHolderWriter writer,
 TypeElement typeElement)

EnumConstantWriterImpl

public EnumConstantWriterImpl(SubWriterHolderWriter writer)

Methodendetails

getMemberSummaryHeader

public Content getMemberSummaryHeader(TypeElement typeElement,
 Content content)

Beschreibung aus Schnittstelle kopiert: MemberSummaryWriter

Returns the member summary header for the given class.

Angegeben von:

getMemberSummaryHeader in Schnittstelle MemberSummaryWriter

Parameter:

typeElement - the class the summary belongs to

content - the content to which the member summary will be added

Gibt zurück:

the member summary header

addSummary

public void addSummary(Content summariesList,
 Content content)

Beschreibung aus Schnittstelle kopiert: MemberSummaryWriter

Adds the given summary to the list of summaries.

Angegeben von:

addSummary in Schnittstelle MemberSummaryWriter

Parameter:

summariesList - the list of summaries

content - the summary

getEnumConstantsDetailsHeader

public Content getEnumConstantsDetailsHeader(TypeElement typeElement,
 Content memberDetails)

Beschreibung aus Schnittstelle kopiert: EnumConstantWriter

Get the enum constants details header.

Angegeben von:

getEnumConstantsDetailsHeader in Schnittstelle EnumConstantWriter

Parameter:

typeElement - the class being documented

memberDetails - the content representing member details

Gibt zurück:

a content for the enum constants details header

getEnumConstantsHeader

public Content getEnumConstantsHeader(VariableElement enumConstant,
 Content enumConstantsDetails)

Beschreibung aus Schnittstelle kopiert: EnumConstantWriter

Get the enum constants documentation header.

Angegeben von:

getEnumConstantsHeader in Schnittstelle EnumConstantWriter

Parameter:

enumConstant - the enum constant being documented

enumConstantsDetails - the content representing enum constant details

Gibt zurück:

the enum constant documentation header

getSignature

public Content getSignature(VariableElement enumConstant)

Beschreibung aus Schnittstelle kopiert: EnumConstantWriter

Get the signature for the given enum constant.

Angegeben von:

getSignature in Schnittstelle EnumConstantWriter

Parameter:

enumConstant - the enum constant being documented

Gibt zurück:

the enum constant signature

addDeprecated

public void addDeprecated(VariableElement enumConstant,
 Content content)

Beschreibung aus Schnittstelle kopiert: EnumConstantWriter

Add the deprecated output for the given enum constant.

Angegeben von:

addDeprecated in Schnittstelle EnumConstantWriter

Parameter:

enumConstant - the enum constant being documented

content - the content to which the deprecated information will be added

addPreview

public void addPreview(VariableElement enumConstant,
 Content content)

Beschreibung aus Schnittstelle kopiert: EnumConstantWriter

Add the preview output for the given member.

Angegeben von:

addPreview in Schnittstelle EnumConstantWriter

Parameter:

enumConstant - the member being documented

content - the content to which the preview information will be added

addComments

public void addComments(VariableElement enumConstant,
 Content enumConstants)

Beschreibung aus Schnittstelle kopiert: EnumConstantWriter

Add the comments for the given enum constant.

Angegeben von:

addComments in Schnittstelle EnumConstantWriter

Parameter:

enumConstant - the enum constant being documented

enumConstants - the content to which the comments will be added

addTags

public void addTags(VariableElement enumConstant,
 Content content)

Beschreibung aus Schnittstelle kopiert: EnumConstantWriter

Add the tags for the given enum constant.

Angegeben von:

addTags in Schnittstelle EnumConstantWriter

Parameter:

enumConstant - the enum constant being documented

content - the content to which the tags will be added

getEnumConstantsDetails

public Content getEnumConstantsDetails(Content memberDetailsHeader,
 Content content)

Beschreibung aus Schnittstelle kopiert: EnumConstantWriter

Get the enum constants details.

Angegeben von:

getEnumConstantsDetails in Schnittstelle EnumConstantWriter

Parameter:

memberDetailsHeader - member details header

content - the content representing member details

Gibt zurück:

the enum constant details

addSummaryLabel

public void addSummaryLabel(Content content)

Beschreibung aus Klasse kopiert: AbstractMemberWriter

Adds the summary label for the member.

Angegeben von:

addSummaryLabel in Klasse AbstractMemberWriter

Parameter:

content - the content to which the label will be added

getSummaryTableHeader

public TableHeader getSummaryTableHeader(Element member)

Beschreibung aus Klasse kopiert: AbstractMemberWriter

Returns the summary table header for the member.

Angegeben von:

getSummaryTableHeader in Klasse AbstractMemberWriter

Parameter:

member - the member to be documented

Gibt zurück:

the summary table header

createSummaryTable

protected Table<Element> createSummaryTable()

Beschreibung aus Klasse kopiert: AbstractMemberWriter

Creates the summary table for this element.

The table should be created and initialized if needed, and configured so that it is ready to add content with Table.addRow(Content[]) and similar methods.

Angegeben von:

createSummaryTable in Klasse AbstractMemberWriter

Gibt zurück:

the summary table

addInheritedSummaryLabel

public void addInheritedSummaryLabel(TypeElement typeElement,
 Content content)

Beschreibung aus Klasse kopiert: AbstractMemberWriter

Adds inherited summary label for the member.

Angegeben von:

addInheritedSummaryLabel in Klasse AbstractMemberWriter

Parameter:

typeElement - the type element to which to link to

content - the content to which the inherited summary label will be added

addSummaryLink

protected void addSummaryLink(HtmlLinkInfo.Kind context,
 TypeElement typeElement,
 Element member,
 Content content)

Beschreibung aus Klasse kopiert: AbstractMemberWriter

Adds the summary link for the member.

Angegeben von:

addSummaryLink in Klasse AbstractMemberWriter

Parameter:

context - the id of the context where the link will be printed

typeElement - the type element to be documented

member - the member to be documented

content - the content to which the summary link will be added

addInheritedSummaryLink

protected void addInheritedSummaryLink(TypeElement typeElement,
 Element member,
 Content target)

Beschreibung aus Klasse kopiert: AbstractMemberWriter

Adds the inherited summary link for the member.

Angegeben von:

addInheritedSummaryLink in Klasse AbstractMemberWriter

Parameter:

typeElement - the type element to be documented

member - the member to be documented

target - the content to which the inherited summary link will be added

addSummaryType

protected void addSummaryType(Element member,
 Content content)

Beschreibung aus Klasse kopiert: AbstractMemberWriter

Adds the summary type for the member.

Angegeben von:

addSummaryType in Klasse AbstractMemberWriter

Parameter:

member - the member to be documented

content - the content to which the type will be added

getSummaryLink

protected Content getSummaryLink(Element member)

Beschreibung aus Klasse kopiert: AbstractMemberWriter

Returns a link for summary (deprecated, preview) pages.

Angegeben von:

getSummaryLink in Klasse AbstractMemberWriter

Parameter:

member - the member being linked to

Gibt zurück:

the link

getMemberHeader

public Content getMemberHeader()

Beschreibung aus Schnittstelle kopiert: EnumConstantWriter

Gets the member header.

Angegeben von:

getMemberHeader in Schnittstelle EnumConstantWriter

Gibt zurück:

the member header