org.jmlspecs.jmldoc.jmldoc_142
Class JmldocConstructorSubWriter

java.lang.Object
  com.sun.tools.doclets.standard.AbstractSubWriter
      com.sun.tools.doclets.standard.ExecutableMemberSubWriter
          com.sun.tools.doclets.standard.ConstructorSubWriter
              org.multijava.mjdoc.mjdoc_142.MjdocConstructorSubWriter
                  org.jmlspecs.jmldoc.jmldoc_142.JmldocConstructorSubWriter

public class JmldocConstructorSubWriter

extends org.multijava.mjdoc.mjdoc_142.MjdocConstructorSubWriter

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

Author:

David R. Cok

Field Summary
protected  JmlHTML	jmlwriter
protected  long	modFields

 

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

foundNonPublicMember

 

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

classdoc, nodepr, printedSummaryHeader, visibleClasses, visibleMemberMap, writer

 

Constructor Summary

JmldocConstructorSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer)

JmldocConstructorSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer, com.sun.javadoc.ClassDoc classdoc)

JmldocConstructorSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer, com.sun.javadoc.ClassDoc classdoc, long mods)

 

Method Summary
protected  void	printFullComment(com.sun.javadoc.ProgramElementDoc emd)
protected  void	printHeader(com.sun.javadoc.ClassDoc cd)
protected  void	printSpecifications(com.sun.javadoc.ProgramElementDoc emd)
void	printSummaryAnchor(com.sun.javadoc.ClassDoc cd)
void	printSummaryLabel(com.sun.javadoc.ClassDoc cd)
protected  void	printSummaryType(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.

 

Methods inherited from class org.multijava.mjdoc.mjdoc_142.MjdocConstructorSubWriter

anyParamTags, getInheritedMethodDoc, printParam, printTags, printTagsInfoFooter, printTagsInfoHeader

 

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

checkForNonPublicMembers, getMemberKind, navSummaryLink, printInheritedSummaryAnchor, printInheritedSummaryLabel, printNavDetailLink, printNavSummaryLink

 

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

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

 

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

bold, buildVisibleMemberMap, configuration, eligibleMembers, isInherited, makeSpace, members, modifierString, msg, navDetailLink, print, print, printComment, printCommentAndTags, printDeprecated, printDeprecatedAPI, printDeprecatedClassComment, printHead, printInheritedMembersSummary, printInheritedSummaryFooter, printInheritedSummaryHeader, printInheritedSummaryMember, printMembers, printMembersSummary, 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

 

Field Detail

jmlwriter

protected JmlHTML jmlwriter

modFields

protected long modFields

JmldocConstructorSubWriter

public JmldocConstructorSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer,
                                  com.sun.javadoc.ClassDoc classdoc,
                                  long mods)

JmldocConstructorSubWriter

public JmldocConstructorSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer,
                                  com.sun.javadoc.ClassDoc classdoc)

JmldocConstructorSubWriter

public JmldocConstructorSubWriter(com.sun.tools.doclets.standard.SubWriterHolderWriter writer)

printFullComment

protected void printFullComment(com.sun.javadoc.ProgramElementDoc emd)

Overrides:

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

printSpecifications

protected void printSpecifications(com.sun.javadoc.ProgramElementDoc emd)

printSummaryLabel

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

Overrides:

printSummaryLabel in class com.sun.tools.doclets.standard.ConstructorSubWriter

printSummaryAnchor

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

Overrides:

printSummaryAnchor in class com.sun.tools.doclets.standard.ConstructorSubWriter

printHeader

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

Overrides:

printHeader in class com.sun.tools.doclets.standard.ConstructorSubWriter

printSummaryType

protected void printSummaryType(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:

printSummaryType in class com.sun.tools.doclets.standard.ConstructorSubWriter