Package gw.gosudoc.com.sun.tools.doclets.formats.html

Class MethodWriterImpl

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractMemberWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.AbstractExecutableMemberWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.MethodWriterImpl
All Implemented Interfaces:
MemberSummaryWriter, MethodWriter
Direct Known Subclasses:
HtmlSerialMethodWriter
@Deprecated public class MethodWriterImpl extends AbstractExecutableMemberWriter implements MethodWriter, MemberSummaryWriter
Deprecated.
Writes method documentation in HTML format.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

  • Constructor Details

    • MethodWriterImpl

      public MethodWriterImpl(SubWriterHolderWriter writer, ClassDoc classDoc)
      Deprecated.
      Construct a new MethodWriterImpl.
      Parameters:
      writer - the writer for the class that the methods belong to.
      classDoc - the class being documented.

    • MethodWriterImpl

      public MethodWriterImpl(SubWriterHolderWriter writer)
      Deprecated.
      Construct a new MethodWriterImpl.
      Parameters:
      writer - The writer for the class that the methods belong to.

  • Method Details

    • getMemberSummaryHeader

      public Content getMemberSummaryHeader(ClassDoc classDoc, Content memberSummaryTree)
      Deprecated.
      Get the member summary header for the given class.
      Specified by:
      getMemberSummaryHeader in interface MemberSummaryWriter
      Parameters:
      classDoc - the class the summary belongs to
      memberSummaryTree - the content tree to which the member summary will be added
      Returns:
      a content tree for the member summary header

    • addMemberTree

      public void addMemberTree(Content memberSummaryTree, Content memberTree)
      Deprecated.
      Add the member tree to the member summary tree.
      Specified by:
      addMemberTree in interface MemberSummaryWriter
      Parameters:
      memberSummaryTree - the content tree representing the member summary
      memberTree - the content tree representing the member

    • getMethodDetailsTreeHeader

      public Content getMethodDetailsTreeHeader(ClassDoc classDoc, Content memberDetailsTree)
      Deprecated.
      Get the method details tree header.
      Specified by:
      getMethodDetailsTreeHeader in interface MethodWriter
      Parameters:
      classDoc - the class being documented
      memberDetailsTree - the content tree representing member details
      Returns:
      content tree for the method details header

    • getMethodDocTreeHeader

      public Content getMethodDocTreeHeader(MethodDoc method, Content methodDetailsTree)
      Deprecated.
      Get the method documentation tree header.
      Specified by:
      getMethodDocTreeHeader in interface MethodWriter
      Parameters:
      method - the method being documented
      methodDetailsTree - the content tree representing method details
      Returns:
      content tree for the method documentation header

    • getSignature

      public Content getSignature(MethodDoc method)
      Deprecated.
      Get the signature for the given method.
      Specified by:
      getSignature in interface MethodWriter
      Parameters:
      method - the method being documented.
      Returns:
      a content object for the signature

    • addDeprecated

      public void addDeprecated(MethodDoc method, Content methodDocTree)
      Deprecated.
      Add the deprecated output for the given method.
      Specified by:
      addDeprecated in interface MethodWriter
      Parameters:
      method - the method being documented
      methodDocTree - content tree to which the deprecated information will be added

    • addComments

      public void addComments(Type holder, MethodDoc method, Content methodDocTree)
      Deprecated.
      Add the comments for the given method.
      Specified by:
      addComments in interface MethodWriter
      Parameters:
      holder - the holder type (not erasure) of the method
      method - the method being documented
      methodDocTree - the content tree to which the comments will be added

    • addTags

      public void addTags(MethodDoc method, Content methodDocTree)
      Deprecated.
      Add the tags for the given method.
      Specified by:
      addTags in interface MethodWriter
      Parameters:
      method - the method being documented
      methodDocTree - the content tree to which the tags will be added

    • getMethodDetails

      public Content getMethodDetails(Content methodDetailsTree)
      Deprecated.
      Get the method details tree.
      Specified by:
      getMethodDetails in interface MethodWriter
      Parameters:
      methodDetailsTree - the content tree representing method details
      Returns:
      content tree for the method details

    • getMethodDoc

      public Content getMethodDoc(Content methodDocTree, boolean isLastContent)
      Deprecated.
      Get the method documentation.
      Specified by:
      getMethodDoc in interface MethodWriter
      Parameters:
      methodDocTree - the content tree representing method documentation
      isLastContent - true if the content to be added is the last content
      Returns:
      content tree for the method documentation

    • close

      public void close() throws IOException
      Deprecated.
      Close the writer.
      Specified by:
      close in interface MemberSummaryWriter
      Specified by:
      close in interface MethodWriter
      Throws:
      IOException

    • getMemberKind

      public int getMemberKind()
      Deprecated.

    • addSummaryLabel

      public void addSummaryLabel(Content memberTree)
      Deprecated.
      Add the summary label for the member.
      Specified by:
      addSummaryLabel in class AbstractMemberWriter
      Parameters:
      memberTree - the content tree to which the label will be added

    • getTableSummary

      public String getTableSummary()
      Deprecated.
      Get the summary for the member summary table.
      Specified by:
      getTableSummary in class AbstractMemberWriter
      Returns:
      a string for the table summary

    • getCaption

      public Content getCaption()
      Deprecated.
      Get the caption for the member summary table.
      Specified by:
      getCaption in class AbstractMemberWriter
      Returns:
      a string for the table caption

    • getSummaryTableHeader

      public String[] getSummaryTableHeader(ProgramElementDoc member)
      Deprecated.
      Get the summary table header for the member.
      Specified by:
      getSummaryTableHeader in class AbstractMemberWriter
      Parameters:
      member - the member to be documented
      Returns:
      the summary table header

    • addSummaryAnchor

      public void addSummaryAnchor(ClassDoc cd, Content memberTree)
      Deprecated.
      Add the anchor for the summary section of the member.
      Specified by:
      addSummaryAnchor in class AbstractMemberWriter
      Parameters:
      cd - the class doc to be documented
      memberTree - the content tree to which the summary anchor will be added

    • addInheritedSummaryAnchor

      public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree)
      Deprecated.
      Add the anchor for the inherited summary section of the member.
      Specified by:
      addInheritedSummaryAnchor in class AbstractMemberWriter
      Parameters:
      cd - the class doc to be documented
      inheritedTree - the content tree to which the inherited summary anchor will be added

    • addInheritedSummaryLabel

      public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree)
      Deprecated.
      Add inherited summary lable for the member.
      Specified by:
      addInheritedSummaryLabel in class AbstractMemberWriter
      Parameters:
      cd - the class doc to which to link to
      inheritedTree - the content tree to which the inherited summary label will be added

    • addSummaryType

      protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType)
      Deprecated.
      Add the summary type for the member.
      Specified by:
      addSummaryType in class AbstractMemberWriter
      Parameters:
      member - the member to be documented
      tdSummaryType - the content tree to which the type will be added

    • addOverridden

      protected static void addOverridden(HtmlDocletWriter writer, Type overriddenType, MethodDoc method, Content dl)
      Deprecated.

    • addImplementsInfo

      protected static void addImplementsInfo(HtmlDocletWriter writer, MethodDoc method, Content dl)
      Deprecated.

    • addReturnType

      protected void addReturnType(MethodDoc method, Content htmltree)
      Deprecated.
      Add the return type.
      Parameters:
      method - the method being documented.
      htmltree - the content tree to which the return type will be added

    • getNavSummaryLink

      protected Content getNavSummaryLink(ClassDoc cd, boolean link)
      Deprecated.
      Get the navigation summary link.
      Specified by:
      getNavSummaryLink in class AbstractMemberWriter
      Parameters:
      cd - the class doc to be documented
      link - true if its a link else the label to be printed
      Returns:
      a content tree for the navigation summary link.

    • addNavDetailLink

      protected void addNavDetailLink(boolean link, Content liNav)
      Deprecated.
      Add the navigation detail link.
      Specified by:
      addNavDetailLink in class AbstractMemberWriter
      Parameters:
      link - true if its a link else the label to be printed
      liNav - the content tree to which the navigation detail link will be added