Class FieldWriterImpl

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

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

        public Content getFieldDocTreeHeader​(FieldDoc field,
                                             Content fieldDetailsTree)
        Deprecated.
        Get the field documentation tree header.
        Specified by:
        getFieldDocTreeHeader in interface FieldWriter
        Parameters:
        field - the constructor being documented
        fieldDetailsTree - the content tree representing field details
        Returns:
        content tree for the field documentation header
      • getSignature

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

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

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

        public void addTags​(FieldDoc field,
                            Content fieldDocTree)
        Deprecated.
        Add the tags for the given field.
        Specified by:
        addTags in interface FieldWriter
        Parameters:
        field - the field being documented
        fieldDocTree - the content tree to which the tags will be added
      • getFieldDetails

        public Content getFieldDetails​(Content fieldDetailsTree)
        Deprecated.
        Get the field details tree.
        Specified by:
        getFieldDetails in interface FieldWriter
        Parameters:
        fieldDetailsTree - the content tree representing member details
        Returns:
        content tree for the field details
      • getFieldDoc

        public Content getFieldDoc​(Content fieldDocTree,
                                   boolean isLastContent)
        Deprecated.
        Get the field documentation.
        Specified by:
        getFieldDoc in interface FieldWriter
        Parameters:
        fieldDocTree - the content tree representing field documentation
        isLastContent - true if the content to be added is the last content
        Returns:
        content tree for the field 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