Package gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders

Class MethodBuilder

java.lang.Object

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder

gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.MethodBuilder

@Deprecated
public class MethodBuilder
extends AbstractMemberBuilder

Deprecated.

Builds documentation for a method.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

Since:

1.5

Author:

Jamie Ho, Bhavesh Patel (Modified)

Nested Class Summary

Nested classes/interfaces inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder

AbstractBuilder.Context

Field Summary

Fields inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder

configuration, containingPackagesSeen, DEBUG, layoutParser, utils

Method Summary

Modifier and Type	Method	Description
void	buildDeprecationInfo(XMLNode node, Content methodDocTree)	Deprecated. Build the deprecation information.
void	buildMethodComments(XMLNode node, Content methodDocTree)	Deprecated. Build the comments for the method.
void	buildMethodDoc(XMLNode node, Content memberDetailsTree)	Deprecated. Build the method documentation.
void	buildSignature(XMLNode node, Content methodDocTree)	Deprecated. Build the signature.
void	buildTagInfo(XMLNode node, Content methodDocTree)	Deprecated. Build the tag information.
static MethodBuilder	getInstance(AbstractBuilder.Context context, ClassDoc classDoc, MethodWriter writer)	Deprecated. Construct a new MethodBuilder.
String	getName()	Deprecated. Return the name of this builder.
VisibleMemberMap	getVisibleMemberMap()	Deprecated. Returns the visible member map for the methods of this class.
MethodWriter	getWriter()	Deprecated. Return the method writer for this builder.
boolean	hasMembersToDocument()	Deprecated. Return true if this subbuilder has anything to document.
List<ProgramElementDoc>	members(ClassDoc classDoc)	Deprecated. Returns a list of methods that will be documented for the given class.

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder

build, build

Methods inherited from class gw.gosudoc.com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder

buildChildren, invokeMethod

Methods inherited from class java.lang.Object

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

Method Details

getInstance

public static MethodBuilder getInstance(AbstractBuilder.Context context,
 ClassDoc classDoc,
 MethodWriter writer)

Deprecated.

Construct a new MethodBuilder.

Parameters:

context - the build context.

classDoc - the class whoses members are being documented.

writer - the doclet specific writer.

Returns:

an instance of a MethodBuilder.

getName

public String getName()

Deprecated.

Return the name of this builder.

Specified by:

getName in class AbstractBuilder

Returns:

the name of the builder.

members

public List<ProgramElementDoc> members(ClassDoc classDoc)

Deprecated.

Returns a list of methods that will be documented for the given class. This information can be used for doclet specific documentation generation.

Parameters:

classDoc - the ClassDoc we want to check.

Returns:

a list of methods that will be documented.

getVisibleMemberMap

public VisibleMemberMap getVisibleMemberMap()

Deprecated.

Returns the visible member map for the methods of this class.

Returns:

the visible member map for the methods of this class.

hasMembersToDocument

public boolean hasMembersToDocument()

Deprecated.

Return true if this subbuilder has anything to document.

Specified by:

hasMembersToDocument in class AbstractMemberBuilder

Returns:

true if this subbuilder has anything to document.

buildMethodDoc

public void buildMethodDoc(XMLNode node,
 Content memberDetailsTree)

Deprecated.

Build the method documentation.

Parameters:

node - the XML element that specifies which components to document

memberDetailsTree - the content tree to which the documentation will be added

buildSignature

public void buildSignature(XMLNode node,
 Content methodDocTree)

Deprecated.

Build the signature.

Parameters:

node - the XML element that specifies which components to document

methodDocTree - the content tree to which the documentation will be added

buildDeprecationInfo

public void buildDeprecationInfo(XMLNode node,
 Content methodDocTree)

Deprecated.

Build the deprecation information.

Parameters:

node - the XML element that specifies which components to document

methodDocTree - the content tree to which the documentation will be added

buildMethodComments

public void buildMethodComments(XMLNode node,
 Content methodDocTree)

Deprecated.

Build the comments for the method. Do nothing if Configuration.nocomment is set to true.

Parameters:

node - the XML element that specifies which components to document

methodDocTree - the content tree to which the documentation will be added

buildTagInfo

public void buildTagInfo(XMLNode node,
 Content methodDocTree)

Deprecated.

Build the tag information.

Parameters:

node - the XML element that specifies which components to document

methodDocTree - the content tree to which the documentation will be added

getWriter

public MethodWriter getWriter()

Deprecated.

Return the method writer for this builder.

Returns:

the method writer for this builder.