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

Klasse PropertyWriterImpl

java.lang.Object

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

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

Alle implementierten Schnittstellen:

MemberSummaryWriter, MemberWriter, PropertyWriter

public class PropertyWriterImpl
extends AbstractMemberWriter
implements PropertyWriter, MemberSummaryWriter

Writes property 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
PropertyWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addComments(ExecutableElement property, Content propertyContent)	Add the comments for the given property.
void	addDeprecated(ExecutableElement property, Content propertyContent)	Add the deprecated output for the given property.
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(ExecutableElement property, 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(ExecutableElement property, Content propertyContent)	Add the tags for the given property.
protected Table<Element>	createSummaryTable()	Creates the summary table for this element.
Content	getMemberSummaryHeader(TypeElement typeElement, Content content)	Returns the member summary header for the given class.
Content	getPropertyDetails(Content memberDetailsHeader, Content memberDetails)	Get the property details.
Content	getPropertyDetailsHeader(Content memberDetails)	Get the property details header.
Content	getPropertyHeaderContent(ExecutableElement property)	Get the property documentation header.
Content	getSignature(ExecutableElement property)	Get the signature for the given property.
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

PropertyWriterImpl

public PropertyWriterImpl(SubWriterHolderWriter writer,
 TypeElement typeElement)

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

getPropertyDetailsHeader

public Content getPropertyDetailsHeader(Content memberDetails)

Beschreibung aus Schnittstelle kopiert: PropertyWriter

Get the property details header.

Angegeben von:

getPropertyDetailsHeader in Schnittstelle PropertyWriter

Parameter:

memberDetails - the content representing member details

Gibt zurück:

the property details header

getPropertyHeaderContent

public Content getPropertyHeaderContent(ExecutableElement property)

Beschreibung aus Schnittstelle kopiert: PropertyWriter

Get the property documentation header.

Angegeben von:

getPropertyHeaderContent in Schnittstelle PropertyWriter

Parameter:

property - the property being documented

Gibt zurück:

the property documentation header

getSignature

public Content getSignature(ExecutableElement property)

Beschreibung aus Schnittstelle kopiert: PropertyWriter

Get the signature for the given property.

Angegeben von:

getSignature in Schnittstelle PropertyWriter

Parameter:

property - the property being documented

Gibt zurück:

the property signature

addDeprecated

public void addDeprecated(ExecutableElement property,
 Content propertyContent)

Beschreibung aus Schnittstelle kopiert: PropertyWriter

Add the deprecated output for the given property.

Angegeben von:

addDeprecated in Schnittstelle PropertyWriter

Parameter:

property - the property being documented

propertyContent - content to which the deprecated information will be added

addPreview

public void addPreview(ExecutableElement property,
 Content content)

Beschreibung aus Schnittstelle kopiert: PropertyWriter

Add the preview output for the given member.

Angegeben von:

addPreview in Schnittstelle PropertyWriter

Parameter:

property - the member being documented

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

addComments

public void addComments(ExecutableElement property,
 Content propertyContent)

Beschreibung aus Schnittstelle kopiert: PropertyWriter

Add the comments for the given property.

Angegeben von:

addComments in Schnittstelle PropertyWriter

Parameter:

property - the property being documented

propertyContent - the content to which the comments will be added

addTags

public void addTags(ExecutableElement property,
 Content propertyContent)

Beschreibung aus Schnittstelle kopiert: PropertyWriter

Add the tags for the given property.

Angegeben von:

addTags in Schnittstelle PropertyWriter

Parameter:

property - the property being documented

propertyContent - the content to which the tags will be added

getPropertyDetails

public Content getPropertyDetails(Content memberDetailsHeader,
 Content memberDetails)

Beschreibung aus Schnittstelle kopiert: PropertyWriter

Get the property details.

Angegeben von:

getPropertyDetails in Schnittstelle PropertyWriter

Parameter:

memberDetailsHeader - the content representing member details header

memberDetails - the content representing member details

Gibt zurück:

the property 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