org.freehep.tools.doclet
Class MethodSubWriter

java.lang.Object
  org.freehep.tools.doclet.AbstractSubWriter
      org.freehep.tools.doclet.ExecutableMemberSubWriter
          org.freehep.tools.doclet.MethodSubWriter

Direct Known Subclasses:

SerialMethodSubWriter

public class MethodSubWriter

extends ExecutableMemberSubWriter

Author:

Robert Field, Atul M Dambalkar

Source Code:

MethodSubWriter.java

Field Summary

Fields inherited from class org.freehep.tools.doclet.AbstractSubWriter

classdoc, nodepr, printedSummaryHeader, visibleClasses, visibleMemberMap, writer

Constructor Summary

MethodSubWriter(SubWriterHolderWriter writer, com.sun.javadoc.ClassDoc classdoc, ConfigurationStandard configuration)

MethodSubWriter(SubWriterHolderWriter writer, ConfigurationStandard configuration)

Method Summary

int	getMemberKind() abstracts
protected com.sun.javadoc.MethodDoc	implementedMethod(com.sun.javadoc.MethodDoc method)
protected String	parseCodeTag(String tag) Parse the <Code> tag and return the text.
protected void	printComment(com.sun.javadoc.ProgramElementDoc member)
protected void	printCommentFromCommentedMethod(com.sun.javadoc.MethodDoc method)
protected void	printHeader(com.sun.javadoc.ClassDoc cd)
protected void	printImplementsInfo(com.sun.javadoc.MethodDoc method)
void	printInheritedSummaryAnchor(com.sun.javadoc.ClassDoc cd)
void	printInheritedSummaryLabel(com.sun.javadoc.ClassDoc cd)
void	printMembersSummary()
protected void	printNavDetailLink(boolean link)
protected void	printNavSummaryLink(com.sun.javadoc.ClassDoc cd, boolean link)
protected void	printOverridden(com.sun.javadoc.ClassDoc overridden, com.sun.javadoc.MethodDoc method)
protected void	printReturnType(com.sun.javadoc.MethodDoc method)
protected void	printSignature(com.sun.javadoc.ExecutableMemberDoc member)
void	printSummaryAnchor(com.sun.javadoc.ClassDoc cd)
void	printSummaryLabel(com.sun.javadoc.ClassDoc cd)
protected void	printSummaryType(com.sun.javadoc.ProgramElementDoc member)
protected void	printTags(com.sun.javadoc.ProgramElementDoc member)
protected void	printTagsInfoFooter()
protected void	printTagsInfoHeader()

Methods inherited from class org.freehep.tools.doclet.ExecutableMemberSubWriter

getReturnTypeLength, implementsMethodInIntfac, name, printBodyHtmlEnd, printDeprecatedLink, printExceptions, printInheritedSummaryLink, printMember, printParam, printParameters, printSummaryLink

Methods inherited from class org.freehep.tools.doclet.AbstractSubWriter

bold, buildVisibleMemberMap, configuration, eligibleMembers, isInherited, makeSpace, members, modifierString, msg, navDetailLink, navSummaryLink, print, print, printCommentAndTags, printDeprecated, printDeprecatedAPI, printDeprecatedClassComment, printFullComment, printHead, printInheritedMembersSummary, printInheritedSummaryFooter, printInheritedSummaryHeader, printInheritedSummaryMember, printMembers, printModifier, printModifierAndType, printModifiers, printStaticAndType, printSummaryFooter, printSummaryHeader, printSummaryMember, printTypedName, printTypeLink, printTypeLinkNoDimension, printUseInfo, serialWarning, typeString

Methods inherited from class java.lang.Object

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

Constructor Detail

MethodSubWriter

public MethodSubWriter(SubWriterHolderWriter writer,
                       com.sun.javadoc.ClassDoc classdoc,
                       ConfigurationStandard configuration)

MethodSubWriter

public MethodSubWriter(SubWriterHolderWriter writer,
                       ConfigurationStandard configuration)

Method Detail

getMemberKind

public int getMemberKind()

Description copied from class: AbstractSubWriter

abstracts

Specified by:

getMemberKind in class AbstractSubWriter

printSummaryLabel

public void printSummaryLabel(com.sun.javadoc.ClassDoc cd)

Specified by:

printSummaryLabel in class AbstractSubWriter

printSummaryAnchor

public void printSummaryAnchor(com.sun.javadoc.ClassDoc cd)

Specified by:

printSummaryAnchor in class AbstractSubWriter

printInheritedSummaryAnchor

public void printInheritedSummaryAnchor(com.sun.javadoc.ClassDoc cd)

Specified by:

printInheritedSummaryAnchor in class AbstractSubWriter

printInheritedSummaryLabel

public void printInheritedSummaryLabel(com.sun.javadoc.ClassDoc cd)

Specified by:

printInheritedSummaryLabel in class AbstractSubWriter

printSummaryType

protected void printSummaryType(com.sun.javadoc.ProgramElementDoc member)

Specified by:

printSummaryType in class AbstractSubWriter

printOverridden

protected void printOverridden(com.sun.javadoc.ClassDoc overridden,
                               com.sun.javadoc.MethodDoc method)

printTags

protected void printTags(com.sun.javadoc.ProgramElementDoc member)

Overrides:

printTags in class AbstractSubWriter

parseCodeTag

protected String parseCodeTag(String tag)

Parse the <Code> tag and return the text.

printTagsInfoHeader

protected void printTagsInfoHeader()

printTagsInfoFooter

protected void printTagsInfoFooter()

printImplementsInfo

protected void printImplementsInfo(com.sun.javadoc.MethodDoc method)

implementedMethod

protected com.sun.javadoc.MethodDoc implementedMethod(com.sun.javadoc.MethodDoc method)

printSignature

protected void printSignature(com.sun.javadoc.ExecutableMemberDoc member)

Overrides:

printSignature in class ExecutableMemberSubWriter

printComment

protected void printComment(com.sun.javadoc.ProgramElementDoc member)

Overrides:

printComment in class AbstractSubWriter

printCommentFromCommentedMethod

protected void printCommentFromCommentedMethod(com.sun.javadoc.MethodDoc method)

printMembersSummary

public void printMembersSummary()

Overrides:

printMembersSummary in class AbstractSubWriter

printReturnType

protected void printReturnType(com.sun.javadoc.MethodDoc method)

printHeader

protected void printHeader(com.sun.javadoc.ClassDoc cd)

Specified by:

printHeader in class AbstractSubWriter

printNavSummaryLink

protected void printNavSummaryLink(com.sun.javadoc.ClassDoc cd,
                                   boolean link)

Specified by:

printNavSummaryLink in class AbstractSubWriter

printNavDetailLink

protected void printNavDetailLink(boolean link)

Specified by:

printNavDetailLink in class AbstractSubWriter