org.freehep.tools.doclet
Class SerialFieldSubWriter

java.lang.Object
  org.freehep.tools.doclet.AbstractSubWriter
      org.freehep.tools.doclet.FieldSubWriter
          org.freehep.tools.doclet.SerialFieldSubWriter

public class SerialFieldSubWriter

extends FieldSubWriter

Generate serialized form for serializable fields. Documentation denoted by the tags serial and serialField<\code> is processed.

Author:

Joe Fialli

Source Code:

SerialFieldSubWriter.java

Field Summary

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

classdoc, nodepr, printedSummaryHeader, visibleClasses, visibleMemberMap, writer

Constructor Summary

SerialFieldSubWriter(SubWriterHolderWriter writer, com.sun.javadoc.ClassDoc classdoc)

Method Summary

void	buildVisibleMemberMap()
List	members(com.sun.javadoc.ClassDoc cd)
protected void	printBodyHtmlEnd(com.sun.javadoc.ClassDoc cd)
protected void	printComment(com.sun.javadoc.ProgramElementDoc member)
protected void	printDeprecatedLink(com.sun.javadoc.ProgramElementDoc member)
protected void	printHeader(com.sun.javadoc.ClassDoc cd)
void	printInheritedSummaryLabel(com.sun.javadoc.ClassDoc cd)
protected void	printInheritedSummaryLink(com.sun.javadoc.ClassDoc cd, com.sun.javadoc.ProgramElementDoc member)
protected void	printMember(com.sun.javadoc.ProgramElementDoc member) Print a default Serializable field or print all Serializable fields documented by serialField tags.
void	printSummaryLabel(com.sun.javadoc.ClassDoc cd)
protected void	printSummaryLink(com.sun.javadoc.ClassDoc cd, com.sun.javadoc.ProgramElementDoc member)
protected void	printSummaryType(com.sun.javadoc.ProgramElementDoc member)
protected void	printTypeLinkNoDimension(com.sun.javadoc.Type type)

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

getMemberKind, printInheritedSummaryAnchor, printNavDetailLink, printNavSummaryLink, printSummaryAnchor

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

SerialFieldSubWriter

public SerialFieldSubWriter(SubWriterHolderWriter writer,
                            com.sun.javadoc.ClassDoc classdoc)

Method Detail

members

public List members(com.sun.javadoc.ClassDoc cd)

Overrides:

members in class AbstractSubWriter

printTypeLinkNoDimension

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

Overrides:

printTypeLinkNoDimension in class AbstractSubWriter

printHeader

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

Overrides:

printHeader in class FieldSubWriter

printBodyHtmlEnd

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

Overrides:

printBodyHtmlEnd in class FieldSubWriter

printMember

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

Print a default Serializable field or print all Serializable fields documented by serialField tags.

Overrides:

printMember in class FieldSubWriter

printComment

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

Overrides:

printComment in class AbstractSubWriter

printDeprecatedLink

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

Overrides:

printDeprecatedLink in class FieldSubWriter

printSummaryLabel

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

Overrides:

printSummaryLabel in class FieldSubWriter

printInheritedSummaryLabel

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

Overrides:

printInheritedSummaryLabel in class FieldSubWriter

printSummaryLink

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

Overrides:

printSummaryLink in class FieldSubWriter

printInheritedSummaryLink

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

Overrides:

printInheritedSummaryLink in class FieldSubWriter

printSummaryType

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

Overrides:

printSummaryType in class FieldSubWriter

buildVisibleMemberMap

public void buildVisibleMemberMap()

Overrides:

buildVisibleMemberMap in class AbstractSubWriter