Class PropertyWriterImpl

  • All Implemented Interfaces:
    MemberSummaryWriter, PropertyWriter

    @Deprecated
    public class PropertyWriterImpl
    extends AbstractMemberWriter
    implements PropertyWriter, MemberSummaryWriter
    Deprecated.
    Writes property 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.

    Author:
    Robert Field, Atul M Dambalkar, Jamie Ho (rewrite), Bhavesh Patel (Modified)
    • Method Detail

      • 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
      • getPropertyDetailsTreeHeader

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

        public Content getPropertyDocTreeHeader​(MethodDoc property,
                                                Content propertyDetailsTree)
        Deprecated.
        Get the property documentation tree header.
        Specified by:
        getPropertyDocTreeHeader in interface PropertyWriter
        Parameters:
        property - the property being documented
        propertyDetailsTree - the content tree representing property details
        Returns:
        content tree for the property documentation header
      • getSignature

        public Content getSignature​(MethodDoc property)
        Deprecated.
        Get the signature for the given property.
        Specified by:
        getSignature in interface PropertyWriter
        Parameters:
        property - the property being documented
        Returns:
        content tree for the property signature
      • addDeprecated

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

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

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

        public Content getPropertyDetails​(Content propertyDetailsTree)
        Deprecated.
        Get the property details tree.
        Specified by:
        getPropertyDetails in interface PropertyWriter
        Parameters:
        propertyDetailsTree - the content tree representing member details
        Returns:
        content tree for the property details
      • getPropertyDoc

        public Content getPropertyDoc​(Content propertyDocTree,
                                      boolean isLastContent)
        Deprecated.
        Get the property documentation.
        Specified by:
        getPropertyDoc in interface PropertyWriter
        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
      • 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
      • 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
      • addSummaryLink

        protected void addSummaryLink​(LinkInfoImpl.Kind context,
                                      ClassDoc cd,
                                      ProgramElementDoc member,
                                      Content tdSummary)
        Deprecated.
        Add the summary link for the member.
        Specified by:
        addSummaryLink in class AbstractMemberWriter
        Parameters:
        context - the id of the context where the link will be printed
        cd - the class doc to be documented
        member - the member to be documented
        tdSummary - the content tree to which the summary link will be added
      • addInheritedSummaryLink

        protected void addInheritedSummaryLink​(ClassDoc cd,
                                               ProgramElementDoc member,
                                               Content linksTree)
        Deprecated.
        Add the inherited summary link for the member.
        Specified by:
        addInheritedSummaryLink in class AbstractMemberWriter
        Parameters:
        cd - the class doc to be documented
        member - the member to be documented
        linksTree - the content tree to which the inherited summary link 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
      • 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