JML

org.jmlspecs.jmldoc.jmldoc_142
Class JmldocMethodSubWriter

java.lang.Object
  extended bycom.sun.tools.doclets.standard.AbstractSubWriter
      extended bycom.sun.tools.doclets.standard.ExecutableMemberSubWriter
          extended bycom.sun.tools.doclets.standard.MethodSubWriter
              extended byorg.multijava.mjdoc.mjdoc_142.MjdocMethodSubWriter
                  extended byorg.jmlspecs.jmldoc.jmldoc_142.JmldocMethodSubWriter

public class JmldocMethodSubWriter
extends org.multijava.mjdoc.mjdoc_142.MjdocMethodSubWriter

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

Author:
David R. Cok

Field Summary
protected  JmlHTML jmlwriter
           
protected  long modFields
           
 
Fields inherited from class org.multijava.mjdoc.mjdoc_142.MjdocMethodSubWriter
configuration, inGFHTMLPage, inMethodHTMLPage
 
Fields inherited from class com.sun.tools.doclets.standard.AbstractSubWriter
classdoc, nodepr, printedSummaryHeader, visibleClasses, visibleMemberMap, writer
 
Constructor Summary
JmldocMethodSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer, com.sun.javadoc.ClassDoc classdoc, com.sun.tools.doclets.standard.ConfigurationStandard config)
           
JmldocMethodSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer, com.sun.javadoc.ClassDoc classdoc, long modFields, com.sun.tools.doclets.standard.ConfigurationStandard config)
           
JmldocMethodSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer, com.sun.tools.doclets.standard.ConfigurationStandard config)
           
 
Method Summary
protected  boolean isInherited(com.sun.javadoc.ProgramElementDoc ped)
           
protected  void printFullComment(com.sun.javadoc.ProgramElementDoc emd)
           
protected  void printHeader(com.sun.javadoc.ClassDoc cd)
           
 void printInheritedSummaryAnchor(com.sun.javadoc.ClassDoc cd)
           
 void printInheritedSummaryLabel(com.sun.javadoc.ClassDoc cd)
           
protected  void printModifier(com.sun.javadoc.ProgramElementDoc member)
          This is overridden in order to insert spec_public and spec_protected as appropriate in the list of modifiers for fields.
 void printSpecification(com.sun.javadoc.ProgramElementDoc emd)
           
 void printSummaryAnchor(com.sun.javadoc.ClassDoc cd)
           
 void printSummaryLabel(com.sun.javadoc.ClassDoc cd)
           
 
Methods inherited from class org.multijava.mjdoc.mjdoc_142.MjdocMethodSubWriter
anyParamTags, printInheritedMembersSummary, printMember, printMembers, printMembersSummary, printMethods, printMethodsSummary, printModifiers, printOverridden, printParam, printSummaryLink, printTags, printTypedName, printTypeLinkNoDimension
 
Methods inherited from class com.sun.tools.doclets.standard.MethodSubWriter
getMemberKind, implementedMethod, parseCodeTag, printComment, printCommentFromCommentedMethod, printImplementsInfo, printNavDetailLink, printNavSummaryLink, printReturnType, printSignature, 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, makeSpace, members, modifierString, msg, navDetailLink, navSummaryLink, print, print, printCommentAndTags, printDeprecated, printDeprecatedAPI, printDeprecatedClassComment, 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

jmlwriter

protected JmlHTML jmlwriter

modFields

protected long modFields
Constructor Detail

JmldocMethodSubWriter

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

JmldocMethodSubWriter

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

JmldocMethodSubWriter

public JmldocMethodSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer,
                             com.sun.tools.doclets.standard.ConfigurationStandard config)
Method Detail

printFullComment

protected void printFullComment(com.sun.javadoc.ProgramElementDoc emd)
Overrides:
printFullComment in class com.sun.tools.doclets.standard.AbstractSubWriter

printSpecification

public void printSpecification(com.sun.javadoc.ProgramElementDoc emd)

printSummaryLabel

public void printSummaryLabel(com.sun.javadoc.ClassDoc cd)
Overrides:
printSummaryLabel in class com.sun.tools.doclets.standard.MethodSubWriter

printSummaryAnchor

public void printSummaryAnchor(com.sun.javadoc.ClassDoc cd)
Overrides:
printSummaryAnchor in class com.sun.tools.doclets.standard.MethodSubWriter

printInheritedSummaryAnchor

public void printInheritedSummaryAnchor(com.sun.javadoc.ClassDoc cd)
Overrides:
printInheritedSummaryAnchor in class com.sun.tools.doclets.standard.MethodSubWriter

printInheritedSummaryLabel

public void printInheritedSummaryLabel(com.sun.javadoc.ClassDoc cd)
Overrides:
printInheritedSummaryLabel in class com.sun.tools.doclets.standard.MethodSubWriter

printHeader

protected void printHeader(com.sun.javadoc.ClassDoc cd)
Overrides:
printHeader in class com.sun.tools.doclets.standard.MethodSubWriter

isInherited

protected boolean isInherited(com.sun.javadoc.ProgramElementDoc ped)
Overrides:
isInherited in class com.sun.tools.doclets.standard.AbstractSubWriter

printModifier

protected void printModifier(com.sun.javadoc.ProgramElementDoc member)
This is overridden in order to insert spec_public and spec_protected as appropriate in the list of modifiers for fields.

Overrides:
printModifier in class org.multijava.mjdoc.mjdoc_142.MjdocMethodSubWriter

JML

JML is Copyright (C) 1998-2002 by Iowa State University and is distributed under the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This release depends on code from the MultiJava project and is based in part on the Kopi project Copyright (C) 1990-99 DMS Decision Management Systems Ges.m.b.H.