Package org.jdrupes.mdoclet.internal.doclets.toolkit.builders

Klasse ConstructorBuilder

java.lang.Object

org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractMemberBuilder

org.jdrupes.mdoclet.internal.doclets.toolkit.builders.ConstructorBuilder

public class ConstructorBuilder
extends AbstractMemberBuilder

Builds documentation for a constructor.

Verschachtelte Klassen - Übersicht

Von Klasse geerbte verschachtelte Klassen/Schnittstellen org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

AbstractBuilder.Context

Feldübersicht

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractMemberBuilder

typeElement, visibleMemberTable

Von Klasse geerbte Felder org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractBuilder

builderFactory, configuration, containingPackagesSeen, messages, options, resources, utils

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	build(Content target)	Build the documentation.
protected void	buildConstructorComments(Content constructorContent)	Build the comments for the constructor.
protected void	buildConstructorDoc(Content target)	Build the constructor documentation.
protected void	buildDeprecationInfo(Content constructorContent)	Build the deprecation information.
protected void	buildPreviewInfo(Content constructorContent)	Build the preview information.
protected void	buildSignature(Content constructorContent)	Build the signature.
protected void	buildTagInfo(Content constructorContent)	Build the tag information.
static ConstructorBuilder	getInstance(AbstractBuilder.Context context, TypeElement typeElement, ConstructorWriter writer)	Construct a new ConstructorBuilder.
ConstructorWriter	getWriter()	Return the constructor writer for this builder.
boolean	hasMembersToDocument()	Returns true if this subbuilder has anything to document.

Von Klasse geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.builders.AbstractMemberBuilder

build, getVisibleMembers

Von Klasse geerbte Methoden java.lang.Object

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

Methodendetails

getInstance

public static ConstructorBuilder getInstance(AbstractBuilder.Context context,
 TypeElement typeElement,
 ConstructorWriter writer)

Construct a new ConstructorBuilder.

Parameter:

context - the build context.

typeElement - the class whose members are being documented.

writer - the doclet specific writer.

Gibt zurück:

the new ConstructorBuilder

hasMembersToDocument

public boolean hasMembersToDocument()

Beschreibung aus Klasse kopiert: AbstractMemberBuilder

Returns true if this subbuilder has anything to document.

Angegeben von:

hasMembersToDocument in Klasse AbstractMemberBuilder

Gibt zurück:

true if this subbuilder has anything to document

getWriter

public ConstructorWriter getWriter()

Return the constructor writer for this builder.

Gibt zurück:

the constructor writer for this builder.

build

public void build(Content target)
           throws DocletException

Beschreibung aus Klasse kopiert: AbstractMemberBuilder

Build the documentation.

Angegeben von:

build in Klasse AbstractMemberBuilder

Parameter:

target - the content into which to add the documentation

Löst aus:

DocletException - if there is a problem building the documentation

buildConstructorDoc

protected void buildConstructorDoc(Content target)
                            throws DocletException

Build the constructor documentation.

Parameter:

target - the content to which the documentation will be added

Löst aus:

DocletException - if there is a problem while building the documentation

buildSignature

protected void buildSignature(Content constructorContent)

Build the signature.

Parameter:

constructorContent - the content to which the documentation will be added

buildDeprecationInfo

protected void buildDeprecationInfo(Content constructorContent)

Build the deprecation information.

Parameter:

constructorContent - the content to which the documentation will be added

buildPreviewInfo

protected void buildPreviewInfo(Content constructorContent)

Build the preview information.

Parameter:

constructorContent - the content to which the documentation will be added

buildConstructorComments

protected void buildConstructorComments(Content constructorContent)

Build the comments for the constructor.

Do nothing if BaseOptions.noComment() is set to true.

Parameter:

constructorContent - the content to which the documentation will be added

buildTagInfo

protected void buildTagInfo(Content constructorContent)

Build the tag information.

Parameter:

constructorContent - the content to which the documentation will be added