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

Schnittstelle MethodWriter

Alle Superschnittstellen:

MemberWriter

Alle bekannten Implementierungsklassen:

HtmlSerialMethodWriter, MethodWriterImpl

public interface MethodWriter
extends MemberWriter

The interface for writing method output.

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
void	addComments(TypeMirror holder, 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.
void	addPreview(ExecutableElement member, Content content)	Adds the preview output for the given member.
void	addTags(ExecutableElement method, Content methodContent)	Add the tags for the given method.
Content	getMemberHeader()	Gets the member header.
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.
Content	getSignature(ExecutableElement method)	Get the signature for the given method.

Von Schnittstelle geerbte Methoden org.jdrupes.mdoclet.internal.doclets.toolkit.MemberWriter

getMemberList, getMemberListItem

Methodendetails

getMethodDetailsHeader

Content getMethodDetailsHeader(Content content)

Get the method details header.

Parameter:

content - the content representing member details

Gibt zurück:

the method details header

getMethodHeader

Content getMethodHeader(ExecutableElement method)

Get the method documentation header.

Parameter:

method - the method being documented

Gibt zurück:

the method documentation header

getSignature

Content getSignature(ExecutableElement method)

Get the signature for the given method.

Parameter:

method - the method being documented

Gibt zurück:

the method signature

addDeprecated

void addDeprecated(ExecutableElement method,
 Content methodContent)

Add the deprecated output for the given method.

Parameter:

method - the method being documented

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

addPreview

void addPreview(ExecutableElement member,
 Content content)

Adds the preview output for the given member.

Parameter:

member - the member being documented

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

addComments

void addComments(TypeMirror holder,
 ExecutableElement method,
 Content methodContent)

Add the comments for the given method.

Parameter:

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

method - the method being documented

methodContent - the content to which the comments will be added

addTags

void addTags(ExecutableElement method,
 Content methodContent)

Add the tags for the given method.

Parameter:

method - the method being documented

methodContent - the content to which the tags will be added

getMethodDetails

Content getMethodDetails(Content methodDetailsHeader,
 Content methodDetails)

Get the method details.

Parameter:

methodDetailsHeader - the content representing method details header

methodDetails - the content representing method details

Gibt zurück:

the method details

getMemberHeader

Content getMemberHeader()

Gets the member header.

Gibt zurück:

the member header