Interface MethodWriter

All Known Implementing Classes:
HtmlSerialMethodWriter, MethodWriterImpl
@Deprecated public interface MethodWriter
Deprecated.
The interface for writing method output.

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.

Since:
1.5

  • Method Details

    • getMethodDetailsTreeHeader

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

    • getMethodDocTreeHeader

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

    • getSignature

      Content getSignature(MethodDoc method)
      Deprecated.
      Get the signature for the given method.
      Parameters:
      method - the method being documented
      Returns:
      content tree for the method signature

    • addDeprecated

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

    • addComments

      void addComments(Type holder, MethodDoc method, Content methodDocTree)
      Deprecated.
      Add the comments for the given method.
      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

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

    • getMethodDetails

      Content getMethodDetails(Content methodDetailsTree)
      Deprecated.
      Get the method details tree.
      Parameters:
      methodDetailsTree - the content tree representing method details
      Returns:
      content tree for the method details

    • getMethodDoc

      Content getMethodDoc(Content methodDocTree, boolean isLastContent)
      Deprecated.
      Get the method documentation.
      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

      void close() throws IOException
      Deprecated.
      Close the writer.
      Throws:
      IOException