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

Klasse MethodWriterImpl

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.MethodWriterImpl

Alle implementierten Schnittstellen:

MemberSummaryWriter, MemberWriter, MethodWriter

Bekannte direkte Unterklassen:

HtmlSerialMethodWriter

public class MethodWriterImpl
extends AbstractExecutableMemberWriter
implements MethodWriter, MemberSummaryWriter

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

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addComments(TypeMirror holderType, ExecutableElement method, Content methodContent)	Add the comments for the given method.
void	addDeprecated(ExecutableElement method, Content methodContent)	Add the deprecated output for the given method.
protected static void	addImplementsInfo(HtmlDocletWriter writer, ExecutableElement method, Collection<ExecutableElement> methods, Content dl)	Adds “implements” information for a method (if appropriate) into a definition list.
void	addInheritedSummaryLabel(TypeElement typeElement, Content content)	Adds inherited summary label for the member.
protected static void	addOverridden(HtmlDocletWriter writer, TypeMirror overriddenType, ExecutableElement method, Content dl)	Adds “overrides” or “specified by” information about a method (if appropriate) into a definition list.
void	addPreview(ExecutableElement method, 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	addSummaryType(Element member, Content content)	Adds the summary type for the member.
void	addTags(ExecutableElement method, Content methodContent)	Add the tags for the given method.
protected Table<Element>	createSummaryTable()	Creates the summary table for this element.
Content	getMemberHeader()	Gets the member header.
Content	getMemberSummaryHeader(TypeElement typeElement, Content target)	Returns the member summary header for the given class.
Content	getMethodDetails(Content methodDetailsHeader, Content methodDetails)	Get the method details.
Content	getMethodDetailsHeader(Content content)	Get the method details header.
Content	getMethodHeader(ExecutableElement method)	Get the method documentation header.
protected Content	getReturnType(ExecutableElement method)	Get the return type for the given method.
Content	getSignature(ExecutableElement method)	Get the signature for the given method.
TableHeader	getSummaryTableHeader(Element member)	Returns the summary table header for the member.

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

MethodWriterImpl

public MethodWriterImpl(SubWriterHolderWriter writer,
 TypeElement typeElement)

Construct a new MethodWriterImpl.

Parameter:

writer - the writer for the class that the methods belong to.

typeElement - the class being documented.

MethodWriterImpl

public MethodWriterImpl(SubWriterHolderWriter writer)

Construct a new MethodWriterImpl.

Parameter:

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

Methodendetails

getMemberSummaryHeader

public Content getMemberSummaryHeader(TypeElement typeElement,
 Content target)

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

target - 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

getMethodDetailsHeader

public Content getMethodDetailsHeader(Content content)

Beschreibung aus Schnittstelle kopiert: MethodWriter

Get the method details header.

Angegeben von:

getMethodDetailsHeader in Schnittstelle MethodWriter

Parameter:

content - the content representing member details

Gibt zurück:

the method details header

getMethodHeader

public Content getMethodHeader(ExecutableElement method)

Beschreibung aus Schnittstelle kopiert: MethodWriter

Get the method documentation header.

Angegeben von:

getMethodHeader in Schnittstelle MethodWriter

Parameter:

method - the method being documented

Gibt zurück:

the method documentation header

getSignature

public Content getSignature(ExecutableElement method)

Beschreibung aus Schnittstelle kopiert: MethodWriter

Get the signature for the given method.

Angegeben von:

getSignature in Schnittstelle MethodWriter

Parameter:

method - the method being documented

Gibt zurück:

the method signature

addDeprecated

public void addDeprecated(ExecutableElement method,
 Content methodContent)

Beschreibung aus Schnittstelle kopiert: MethodWriter

Add the deprecated output for the given method.

Angegeben von:

addDeprecated in Schnittstelle MethodWriter

Parameter:

method - the method being documented

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

addPreview

public void addPreview(ExecutableElement method,
 Content content)

Beschreibung aus Schnittstelle kopiert: MethodWriter

Adds the preview output for the given member.

Angegeben von:

addPreview in Schnittstelle MethodWriter

Parameter:

method - the member being documented

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

addComments

public void addComments(TypeMirror holderType,
 ExecutableElement method,
 Content methodContent)

Beschreibung aus Schnittstelle kopiert: MethodWriter

Add the comments for the given method.

Angegeben von:

addComments in Schnittstelle MethodWriter

Parameter:

holderType - the holder type (not erasure) of the method

method - the method being documented

methodContent - the content to which the comments will be added

addTags

public void addTags(ExecutableElement method,
 Content methodContent)

Beschreibung aus Schnittstelle kopiert: MethodWriter

Add the tags for the given method.

Angegeben von:

addTags in Schnittstelle MethodWriter

Parameter:

method - the method being documented

methodContent - the content to which the tags will be added

getMethodDetails

public Content getMethodDetails(Content methodDetailsHeader,
 Content methodDetails)

Beschreibung aus Schnittstelle kopiert: MethodWriter

Get the method details.

Angegeben von:

getMethodDetails in Schnittstelle MethodWriter

Parameter:

methodDetailsHeader - the content representing method details header

methodDetails - the content representing method details

Gibt zurück:

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

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

addOverridden

protected static void addOverridden(HtmlDocletWriter writer,
 TypeMirror overriddenType,
 ExecutableElement method,
 Content dl)

Adds “overrides” or “specified by” information about a method (if appropriate) into a definition list.

Parameter:

writer - the writer for the element

overriddenType - the superclass

method - the method

dl - the list in which to add the information.

addImplementsInfo

protected static void addImplementsInfo(HtmlDocletWriter writer,
 ExecutableElement method,
 Collection<ExecutableElement> methods,
 Content dl)

Adds “implements” information for a method (if appropriate) into a definition list.

Parameter:

writer - the writer for the method

method - the method

methods - implemented methods

dl - the definition list

getReturnType

protected Content getReturnType(ExecutableElement method)

Get the return type for the given method.

Parameter:

method - the method being documented.

Gibt zurück:

the return type

getMemberHeader

public Content getMemberHeader()

Beschreibung aus Schnittstelle kopiert: MethodWriter

Gets the member header.

Angegeben von:

getMemberHeader in Schnittstelle MethodWriter

Gibt zurück:

the member header