org.multijava.mjdoc.mjdoc_142
Class MjdocMethodSubWriter

java.lang.Object
  com.sun.tools.doclets.standard.AbstractSubWriter
      com.sun.tools.doclets.standard.ExecutableMemberSubWriter
          com.sun.tools.doclets.standard.MethodSubWriter
              org.multijava.mjdoc.mjdoc_142.MjdocMethodSubWriter

public class MjdocMethodSubWriter

extends com.sun.tools.doclets.standard.MethodSubWriter

This is an extension of the doclet api in order to provide functionality for writing external methods.

Author:

David R. Cok

Field Summary
protected  com.sun.tools.doclets.standard.ConfigurationStandard	configuration
boolean	inGFHTMLPage
protected  boolean	inMethodHTMLPage

 

Fields inherited from class com.sun.tools.doclets.standard.AbstractSubWriter

classdoc, nodepr, printedSummaryHeader, visibleClasses, visibleMemberMap, writer

 

Constructor Summary

MjdocMethodSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer, com.sun.javadoc.ClassDoc classdoc, com.sun.tools.doclets.standard.ConfigurationStandard config)

MjdocMethodSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer, com.sun.tools.doclets.standard.ConfigurationStandard config)

 

Method Summary
protected  boolean	anyParamTags(com.sun.javadoc.ExecutableMemberDoc execHolder)
void	printInheritedMembersSummary()
protected  void	printMember(com.sun.javadoc.ProgramElementDoc member)           This prints the detail entry for a constructor or method in either a class page or a generic function page.
void	printMembers()
void	printMembersSummary()
void	printMethods(ArrayList methods)
void	printMethodsSummary(ArrayList methods)
protected  void	printModifier(com.sun.javadoc.ProgramElementDoc member)
protected  void	printModifiers(com.sun.javadoc.MemberDoc member)
protected  void	printOverridden(com.sun.javadoc.ClassDoc overridden, com.sun.javadoc.MethodDoc method)
protected  void	printParam(com.sun.javadoc.Parameter param)
protected  void	printSummaryLink(com.sun.javadoc.ClassDoc cd, com.sun.javadoc.ProgramElementDoc member)
protected  void	printTags(com.sun.javadoc.ProgramElementDoc member)           Prints the html for the tag information.
protected  void	printTypedName(com.sun.javadoc.Type type, String name)
protected  void	printTypeLinkNoDimension(com.sun.javadoc.Type type)

 

Methods inherited from class com.sun.tools.doclets.standard.MethodSubWriter

getMemberKind, implementedMethod, parseCodeTag, printComment, printCommentFromCommentedMethod, printHeader, printImplementsInfo, printInheritedSummaryAnchor, printInheritedSummaryLabel, printNavDetailLink, printNavSummaryLink, printReturnType, printSignature, printSummaryAnchor, printSummaryLabel, printSummaryType, printTagsInfoFooter, printTagsInfoHeader

 

Methods inherited from class com.sun.tools.doclets.standard.ExecutableMemberSubWriter

getReturnTypeLength, implementsMethodInIntfac, name, printBodyHtmlEnd, printDeprecatedLink, printExceptions, printInheritedSummaryLink, printParameters

 

Methods inherited from class com.sun.tools.doclets.standard.AbstractSubWriter

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

 

Methods inherited from class java.lang.Object

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

 

Field Detail

inMethodHTMLPage

protected boolean inMethodHTMLPage

inGFHTMLPage

public boolean inGFHTMLPage

configuration

protected com.sun.tools.doclets.standard.ConfigurationStandard configuration

MjdocMethodSubWriter

public MjdocMethodSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer,
                            com.sun.javadoc.ClassDoc classdoc,
                            com.sun.tools.doclets.standard.ConfigurationStandard config)

MjdocMethodSubWriter

public MjdocMethodSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer,
                            com.sun.tools.doclets.standard.ConfigurationStandard config)

printMembersSummary

public void printMembersSummary()

Overrides:

printMembersSummary in class com.sun.tools.doclets.standard.MethodSubWriter

printMethodsSummary

public void printMethodsSummary(ArrayList methods)

printMembers

public void printMembers()

Overrides:

printMembers in class com.sun.tools.doclets.standard.AbstractSubWriter

printMethods

public void printMethods(ArrayList methods)

printTypedName

protected void printTypedName(com.sun.javadoc.Type type,
                              String name)

Overrides:

printTypedName in class com.sun.tools.doclets.standard.AbstractSubWriter

printSummaryLink

protected void printSummaryLink(com.sun.javadoc.ClassDoc cd,
                                com.sun.javadoc.ProgramElementDoc member)

Overrides:

printSummaryLink in class com.sun.tools.doclets.standard.ExecutableMemberSubWriter

printMember

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

This prints the detail entry for a constructor or method in either a class page or a generic function page.

Overrides:

printMember in class com.sun.tools.doclets.standard.ExecutableMemberSubWriter

printOverridden

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

Overrides:

printOverridden in class com.sun.tools.doclets.standard.MethodSubWriter

printTags

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

Prints the html for the tag information. This method is overridden from MethodSubWriter to fix this bug: when there are not throws tags but there are exceptions declared as thrown, the header for the throws tags is not placed in the html. It is also overridden to clean up some formatting (blank lines) in the output.

Overrides:

printTags in class com.sun.tools.doclets.standard.MethodSubWriter

printParam

protected void printParam(com.sun.javadoc.Parameter param)

Overrides:

printParam in class com.sun.tools.doclets.standard.ExecutableMemberSubWriter

anyParamTags

protected boolean anyParamTags(com.sun.javadoc.ExecutableMemberDoc execHolder)

printInheritedMembersSummary

public void printInheritedMembersSummary()

Overrides:

printInheritedMembersSummary in class com.sun.tools.doclets.standard.AbstractSubWriter

printModifier

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

Overrides:

printModifier in class com.sun.tools.doclets.standard.AbstractSubWriter

printModifiers

protected void printModifiers(com.sun.javadoc.MemberDoc member)

Overrides:

printModifiers in class com.sun.tools.doclets.standard.AbstractSubWriter

printTypeLinkNoDimension

protected void printTypeLinkNoDimension(com.sun.javadoc.Type type)

Overrides:

printTypeLinkNoDimension in class com.sun.tools.doclets.standard.AbstractSubWriter