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

Klasse AnnotationTypeMemberWriterImpl

java.lang.Object

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

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

Alle implementierten Schnittstellen:

AnnotationTypeMemberWriter, MemberSummaryWriter, MemberWriter

public class AnnotationTypeMemberWriterImpl
extends AbstractMemberWriter
implements AnnotationTypeMemberWriter, MemberSummaryWriter

Writes annotation interface member 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
AnnotationTypeMemberWriterImpl(SubWriterHolderWriter writer)	Constructs a new AnnotationTypeMemberWriterImpl for any kind of member.
AnnotationTypeMemberWriterImpl(SubWriterHolderWriter writer, TypeElement annotationType, org.jdrupes.mdoclet.internal.doclets.formats.html.AnnotationTypeMemberWriterImpl.Kind kind)	Constructs a new AnnotationTypeMemberWriterImpl for a specific kind of member.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addAnnotationDetailsMarker(Content memberDetails)	Adds the annotation type details marker.
void	addComments(Element member, Content annotationContent)	Adds the comments for the given member.
void	addDefaultValueInfo(Element member, Content annotationContent)	Adds the default value documentation if the member has one.
void	addDeprecated(Element member, Content target)	Adds the deprecated output for the given member.
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(Element member, Content content)	Adds 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(Element member, Content annotationContent)	Adds the tags for the given member.
protected Table<Element>	createSummaryTable()	Creates the summary table for this element.
Content	getAnnotationDetails(Content annotationDetailsHeader, Content annotationDetails)	Gets the annotation type details.
Content	getAnnotationDetailsHeader()	Adds the annotation type details header.
Content	getAnnotationHeaderContent(Element member)	Gets the annotation type documentation header.
protected Content	getCaption()	Get the caption for the summary table.
Content	getMemberHeader()	Adds the annotation type member header.
Content	getMemberSummaryHeader(TypeElement typeElement, Content content)	Returns the member summary header for the given class.
Content	getSignature(Element member)	Gibt the signature for the specified member zurück.
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.
protected Comment	selectComment(Comment c1, Comment c2)

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

AnnotationTypeMemberWriterImpl

public AnnotationTypeMemberWriterImpl(SubWriterHolderWriter writer)

Constructs a new AnnotationTypeMemberWriterImpl for any kind of member.

Parameter:

writer - The writer for the class that the member belongs to.

AnnotationTypeMemberWriterImpl

public AnnotationTypeMemberWriterImpl(SubWriterHolderWriter writer,
 TypeElement annotationType,
 org.jdrupes.mdoclet.internal.doclets.formats.html.AnnotationTypeMemberWriterImpl.Kind kind)

Constructs a new AnnotationTypeMemberWriterImpl for a specific kind of member.

Parameter:

writer - the writer that will write the output.

annotationType - the AnnotationType that holds this member.

kind - the kind of annotation interface members to handle.

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

getMemberHeader

public Content getMemberHeader()

Beschreibung aus Schnittstelle kopiert: AnnotationTypeMemberWriter

Adds the annotation type member header.

Angegeben von:

getMemberHeader in Schnittstelle AnnotationTypeMemberWriter

Gibt zurück:

the content for the member 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

addAnnotationDetailsMarker

public void addAnnotationDetailsMarker(Content memberDetails)

Beschreibung aus Schnittstelle kopiert: AnnotationTypeMemberWriter

Adds the annotation type details marker.

Angegeben von:

addAnnotationDetailsMarker in Schnittstelle AnnotationTypeMemberWriter

Parameter:

memberDetails - the content representing details marker

getAnnotationDetailsHeader

public Content getAnnotationDetailsHeader()

Beschreibung aus Schnittstelle kopiert: AnnotationTypeMemberWriter

Adds the annotation type details header.

Angegeben von:

getAnnotationDetailsHeader in Schnittstelle AnnotationTypeMemberWriter

Gibt zurück:

the content for the annotation details header

getAnnotationHeaderContent

public Content getAnnotationHeaderContent(Element member)

Beschreibung aus Schnittstelle kopiert: AnnotationTypeMemberWriter

Gets the annotation type documentation header.

Angegeben von:

getAnnotationHeaderContent in Schnittstelle AnnotationTypeMemberWriter

Parameter:

member - the annotation type being documented

Gibt zurück:

the content for the annotation type documentation header

getSignature

public Content getSignature(Element member)

Beschreibung aus Schnittstelle kopiert: AnnotationTypeMemberWriter

Gibt the signature for the specified member zurück.

Angegeben von:

getSignature in Schnittstelle AnnotationTypeMemberWriter

Parameter:

member - the member being documented

Gibt zurück:

the signature for the specified member

addDeprecated

public void addDeprecated(Element member,
 Content target)

Beschreibung aus Schnittstelle kopiert: AnnotationTypeMemberWriter

Adds the deprecated output for the given member.

Angegeben von:

addDeprecated in Schnittstelle AnnotationTypeMemberWriter

Parameter:

member - the member being documented

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

addPreview

public void addPreview(Element member,
 Content content)

Beschreibung aus Schnittstelle kopiert: AnnotationTypeMemberWriter

Adds the preview output for the given member.

Angegeben von:

addPreview in Schnittstelle AnnotationTypeMemberWriter

Parameter:

member - the member being documented

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

addComments

public void addComments(Element member,
 Content annotationContent)

Beschreibung aus Schnittstelle kopiert: AnnotationTypeMemberWriter

Adds the comments for the given member.

Angegeben von:

addComments in Schnittstelle AnnotationTypeMemberWriter

Parameter:

member - the member being documented

annotationContent - the content to which the comments will be added

addTags

public void addTags(Element member,
 Content annotationContent)

Beschreibung aus Schnittstelle kopiert: AnnotationTypeMemberWriter

Adds the tags for the given member.

Angegeben von:

addTags in Schnittstelle AnnotationTypeMemberWriter

Parameter:

member - the member being documented

annotationContent - the content to which the tags will be added

getAnnotationDetails

public Content getAnnotationDetails(Content annotationDetailsHeader,
 Content annotationDetails)

Beschreibung aus Schnittstelle kopiert: AnnotationTypeMemberWriter

Gets the annotation type details.

Angegeben von:

getAnnotationDetails in Schnittstelle AnnotationTypeMemberWriter

Parameter:

annotationDetailsHeader - the content representing annotation type details header

annotationDetails - the content representing annotation type details

Gibt zurück:

the annotation type 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

getCaption

protected Content getCaption()

Get the caption for the summary table.

Gibt zurück:

the caption

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

selectComment

protected Comment selectComment(Comment c1,
 Comment c2)

addDefaultValueInfo

public void addDefaultValueInfo(Element member,
 Content annotationContent)

Beschreibung aus Schnittstelle kopiert: AnnotationTypeMemberWriter

Adds the default value documentation if the member has one.

Angegeben von:

addDefaultValueInfo in Schnittstelle AnnotationTypeMemberWriter

Parameter:

member - the member being documented

annotationContent - the content to which the default value will be added