Interface PropertyWriter

All Known Implementing Classes:
PropertyWriterImpl

@Deprecated public interface PropertyWriter
Deprecated.
The interface for writing property 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.7
  • Method Details

    • getPropertyDetailsTreeHeader

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

      Content getPropertyDocTreeHeader(MethodDoc property, Content propertyDetailsTree)
      Deprecated.
      Get the property documentation tree header.
      Parameters:
      property - the property being documented
      propertyDetailsTree - the content tree representing property details
      Returns:
      content tree for the property documentation header
    • getSignature

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

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

      void addComments(MethodDoc property, Content propertyDocTree)
      Deprecated.
      Add the comments for the given property.
      Parameters:
      property - the property being documented
      propertyDocTree - the content tree to which the comments will be added
    • addTags

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

      Content getPropertyDetails(Content memberDetailsTree)
      Deprecated.
      Get the property details tree.
      Parameters:
      memberDetailsTree - the content tree representing member details
      Returns:
      content tree for the property details
    • getPropertyDoc

      Content getPropertyDoc(Content propertyDocTree, boolean isLastContent)
      Deprecated.
      Get the property documentation.
      Parameters:
      propertyDocTree - the content tree representing property documentation
      isLastContent - true if the content to be added is the last content
      Returns:
      content tree for the property documentation
    • close

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