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

Klasse ConstructorWriterImpl

java.lang.Object

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

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

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

Alle implementierten Schnittstellen:

ConstructorWriter, MemberSummaryWriter, MemberWriter

public class ConstructorWriterImpl
extends AbstractExecutableMemberWriter
implements ConstructorWriter, MemberSummaryWriter

Writes constructor documentation.

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
ConstructorWriterImpl(SubWriterHolderWriter writer)	Construct a new ConstructorWriterImpl.
ConstructorWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement)	Construct a new ConstructorWriterImpl.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addComments(ExecutableElement constructor, Content constructorContent)	Add the comments for the given constructor.
void	addDeprecated(ExecutableElement constructor, Content constructorContent)	Add the deprecated output for the given constructor.
void	addInheritedSummaryLabel(TypeElement typeElement, Content content)	Adds inherited summary label for the member.
void	addPreview(ExecutableElement constructor, 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	addSummaryType(Element member, Content content)	Adds the summary type for the member.
void	addTags(ExecutableElement constructor, Content constructorContent)	Add the tags for the given constructor.
protected Table<Element>	createSummaryTable()	Creates the summary table for this element.
Content	getConstructorDetails(Content memberDetailsHeader, Content memberDetails)	Gibt the constructor details zurück.
Content	getConstructorDetailsHeader(Content content)	Gibt the constructor details header zurück.
Content	getConstructorHeaderContent(ExecutableElement constructor)	Gibt the constructor documentation header zurück.
Content	getMemberHeader()
Content	getMemberSummaryHeader(TypeElement typeElement, Content content)	Returns the member summary header for the given class.
Content	getSignature(ExecutableElement constructor)	Gibt the signature for the given constructor zurück.
TableHeader	getSummaryTableHeader(Element member)	Returns the summary table header for the member.
void	setFoundNonPubConstructor(boolean foundNonPubConstructor)	Let the writer know whether a non public constructor was found.

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

addInheritedSummaryLink, addParam, addParameters, addReceiver, addSummaryLink, getExceptions, getParameters, getSummaryLink, getTypeParameters, implementsMethodInIntfac, isAnnotatedReceiver

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

ConstructorWriterImpl

public ConstructorWriterImpl(SubWriterHolderWriter writer,
 TypeElement typeElement)

Construct a new ConstructorWriterImpl.

Parameter:

writer - The writer for the class that the constructors belong to.

typeElement - the class being documented.

ConstructorWriterImpl

public ConstructorWriterImpl(SubWriterHolderWriter writer)

Construct a new ConstructorWriterImpl.

Parameter:

writer - The writer for the class that the constructors belong to.

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

getConstructorDetailsHeader

public Content getConstructorDetailsHeader(Content content)

Beschreibung aus Schnittstelle kopiert: ConstructorWriter

Gibt the constructor details header zurück.

Angegeben von:

getConstructorDetailsHeader in Schnittstelle ConstructorWriter

Parameter:

content - the content representing member details

Gibt zurück:

the constructor details header

getConstructorHeaderContent

public Content getConstructorHeaderContent(ExecutableElement constructor)

Beschreibung aus Schnittstelle kopiert: ConstructorWriter

Gibt the constructor documentation header zurück.

Angegeben von:

getConstructorHeaderContent in Schnittstelle ConstructorWriter

Parameter:

constructor - the constructor being documented

Gibt zurück:

the constructor documentation header

getSignature

public Content getSignature(ExecutableElement constructor)

Beschreibung aus Schnittstelle kopiert: ConstructorWriter

Gibt the signature for the given constructor zurück.

Angegeben von:

getSignature in Schnittstelle ConstructorWriter

Parameter:

constructor - the constructor being documented

Gibt zurück:

the signature for the given constructor

addDeprecated

public void addDeprecated(ExecutableElement constructor,
 Content constructorContent)

Beschreibung aus Schnittstelle kopiert: ConstructorWriter

Add the deprecated output for the given constructor.

Angegeben von:

addDeprecated in Schnittstelle ConstructorWriter

Parameter:

constructor - the constructor being documented

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

addPreview

public void addPreview(ExecutableElement constructor,
 Content content)

Beschreibung aus Schnittstelle kopiert: ConstructorWriter

Add the preview output for the given member.

Angegeben von:

addPreview in Schnittstelle ConstructorWriter

Parameter:

constructor - the member being documented

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

addComments

public void addComments(ExecutableElement constructor,
 Content constructorContent)

Beschreibung aus Schnittstelle kopiert: ConstructorWriter

Add the comments for the given constructor.

Angegeben von:

addComments in Schnittstelle ConstructorWriter

Parameter:

constructor - the constructor being documented

constructorContent - the content to which the comments will be added

addTags

public void addTags(ExecutableElement constructor,
 Content constructorContent)

Beschreibung aus Schnittstelle kopiert: ConstructorWriter

Add the tags for the given constructor.

Angegeben von:

addTags in Schnittstelle ConstructorWriter

Parameter:

constructor - the constructor being documented

constructorContent - the content to which the tags will be added

getConstructorDetails

public Content getConstructorDetails(Content memberDetailsHeader,
 Content memberDetails)

Beschreibung aus Schnittstelle kopiert: ConstructorWriter

Gibt the constructor details zurück.

Angegeben von:

getConstructorDetails in Schnittstelle ConstructorWriter

Parameter:

memberDetailsHeader - the content representing member details header

memberDetails - the content representing member details

Gibt zurück:

the constructor details

setFoundNonPubConstructor

public void setFoundNonPubConstructor(boolean foundNonPubConstructor)

Beschreibung aus Schnittstelle kopiert: ConstructorWriter

Let the writer know whether a non public constructor was found.

Angegeben von:

setFoundNonPubConstructor in Schnittstelle ConstructorWriter

Parameter:

foundNonPubConstructor - true if we found a non public constructor.

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

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

getMemberHeader

public Content getMemberHeader()

Angegeben von:

getMemberHeader in Schnittstelle ConstructorWriter

Gibt zurück:

the member header}