|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder
com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder
com.sun.tools.doclets.internal.toolkit.builders.MethodBuilder
public class MethodBuilder
Builds documentation for a method. This code is not part of an API. It is implementation that is subject to change. Do not use it as an API
Field Summary | |
---|---|
private ClassDoc |
classDoc
The class whose methods are being documented. |
private int |
currentMethodIndex
The index of the current field that is being documented at this point in time. |
private java.util.List<ProgramElementDoc> |
methods
The methods being documented. |
private VisibleMemberMap |
visibleMemberMap
The visible methods for the given class. |
private MethodWriter |
writer
The writer to output the method documentation. |
Fields inherited from class com.sun.tools.doclets.internal.toolkit.builders.AbstractBuilder |
---|
configuration, containingPackagesSeen, DEBUG |
Constructor Summary | |
---|---|
private |
MethodBuilder(Configuration configuration)
|
Method Summary | |
---|---|
void |
buildDeprecationInfo()
Build the deprecation information. |
void |
buildFooter()
Build the overall footer. |
void |
buildHeader()
Build the overall header. |
void |
buildMethodComments()
Build the comments for the method. |
void |
buildMethodDoc(java.util.List<?> elements)
Build the method documentation. |
void |
buildMethodFooter()
Build the footer of the method. |
void |
buildMethodHeader()
Build the header for the individual method. |
void |
buildSignature()
Build the signature. |
void |
buildTagInfo()
Build the tag information. |
static MethodBuilder |
getInstance(Configuration configuration,
ClassDoc classDoc,
MethodWriter writer)
Construct a new MethodBuilder. |
java.lang.String |
getName()
Return the name of this builder. |
VisibleMemberMap |
getVisibleMemberMap()
Returns the visible member map for the methods of this class. |
MethodWriter |
getWriter()
Return the method writer for this builder. |
boolean |
hasMembersToDocument()
Return true if this subbuilder has anything to document. |
void |
invokeMethod(java.lang.String methodName,
java.lang.Class<?>[] paramClasses,
java.lang.Object[] params)
Given the name and parameters, invoke the method in the builder. |
java.util.List<ProgramElementDoc> |
members(ClassDoc classDoc)
Returns a list of methods that will be documented for the given class. |
Methods inherited from class com.sun.tools.doclets.internal.toolkit.builders.AbstractMemberBuilder |
---|
build, build |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
private int currentMethodIndex
private ClassDoc classDoc
private VisibleMemberMap visibleMemberMap
private MethodWriter writer
private java.util.List<ProgramElementDoc> methods
Constructor Detail |
---|
private MethodBuilder(Configuration configuration)
Method Detail |
---|
public static MethodBuilder getInstance(Configuration configuration, ClassDoc classDoc, MethodWriter writer)
configuration
- the current configuration of the doclet.classDoc
- the class whoses members are being documented.writer
- the doclet specific writer.
public java.lang.String getName()
getName
in class AbstractBuilder
public void invokeMethod(java.lang.String methodName, java.lang.Class<?>[] paramClasses, java.lang.Object[] params) throws java.lang.Exception
invokeMethod
in class AbstractBuilder
methodName
- the name of the method that we would like to invoke.paramClasses
- the types for each parameter.params
- the parameters of the method.
java.lang.Exception
public java.util.List<ProgramElementDoc> members(ClassDoc classDoc)
classDoc
- the ClassDoc
we want to check.
public VisibleMemberMap getVisibleMemberMap()
public boolean hasMembersToDocument()
hasMembersToDocument
in class AbstractMemberBuilder
public void buildMethodDoc(java.util.List<?> elements)
public void buildHeader()
public void buildMethodHeader()
public void buildSignature()
public void buildDeprecationInfo()
public void buildMethodComments()
Configuration.nocomment
is set to true. If this method
public void buildTagInfo()
public void buildMethodFooter()
public void buildFooter()
public MethodWriter getWriter()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES All Classes | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |