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

Class AbstractMemberWriter

    • Field Detail

      • utils

        protected final Utils utils
        Deprecated.

      • classdoc

        protected final ClassDoc classdoc
        Deprecated.

      • nodepr

        public final boolean nodepr
        Deprecated.

      • printedSummaryHeader

        protected boolean printedSummaryHeader
        Deprecated.

    • Method Detail

      • addSummaryLabel

        public abstract void addSummaryLabel​(Content memberTree)
        Deprecated.
        Add the summary label for the member.
        Parameters:
        memberTree - the content tree to which the label will be added

      • getTableSummary

        public abstract String getTableSummary()
        Deprecated.
        Get the summary for the member summary table.
        Returns:
        a string for the table summary

      • getCaption

        public abstract Content getCaption()
        Deprecated.
        Get the caption for the member summary table.
        Returns:
        a string for the table caption

      • getSummaryTableHeader

        public abstract String[] getSummaryTableHeader​(ProgramElementDoc member)
        Deprecated.
        Get the summary table header for the member.
        Parameters:
        member - the member to be documented
        Returns:
        the summary table header

      • addInheritedSummaryLabel

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

      • addSummaryAnchor

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

      • addInheritedSummaryAnchor

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

      • addSummaryType

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

      • addSummaryLink

        protected void addSummaryLink​(ClassDoc cd,
                              ProgramElementDoc member,
                              Content tdSummary)
        Deprecated.
        Add the summary link for the member.
        Parameters:
        cd - the class doc to be documented
        member - the member to be documented
        tdSummary - the content tree to which the link will be added

      • addSummaryLink

        protected abstract void addSummaryLink​(LinkInfoImpl.Kind context,
                                       ClassDoc cd,
                                       ProgramElementDoc member,
                                       Content tdSummary)
        Deprecated.
        Add the summary link for the member.
        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 abstract void addInheritedSummaryLink​(ClassDoc cd,
                                                ProgramElementDoc member,
                                                Content linksTree)
        Deprecated.
        Add the inherited summary link for the member.
        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

      • getDeprecatedLink

        protected abstract Content getDeprecatedLink​(ProgramElementDoc member)
        Deprecated.
        Get the deprecated link.
        Parameters:
        member - the member being linked to
        Returns:
        a content tree representing the link

      • getNavSummaryLink

        protected abstract Content getNavSummaryLink​(ClassDoc cd,
                                             boolean link)
        Deprecated.
        Get the navigation summary link.
        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 abstract void addNavDetailLink​(boolean link,
                                         Content liNav)
        Deprecated.
        Add the navigation detail link.
        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

      • addName

        protected void addName​(String name,
                       Content htmltree)
        Deprecated.
        Add the member name to the content tree.
        Parameters:
        name - the member name to be added to the content tree.
        htmltree - the content tree to which the name will be added.

      • modifierString

        protected String modifierString​(MemberDoc member)
        Deprecated.
        Return a string describing the access modifier flags. Don't include native or synchronized. The modifier names are returned in canonical order, as specified by The Java Language Specification.

      • typeString

        protected String typeString​(MemberDoc member)
        Deprecated.

      • addModifiers

        protected void addModifiers​(MemberDoc member,
                            Content htmltree)
        Deprecated.
        Add the modifier for the member.
        Parameters:
        member - the member for which teh modifier will be added.
        htmltree - the content tree to which the modifier information will be added.

      • makeSpace

        protected String makeSpace​(int len)
        Deprecated.

      • addModifierAndType

        protected void addModifierAndType​(ProgramElementDoc member,
                                  Type type,
                                  Content tdSummaryType)
        Deprecated.
        Add the modifier and type for the member in the member summary.
        Parameters:
        member - the member to add the type for
        type - the type to add
        tdSummaryType - the content tree to which the modified and type will be added

      • addDeprecatedInfo

        protected void addDeprecatedInfo​(ProgramElementDoc member,
                                 Content contentTree)
        Deprecated.
        Add the deprecated information for the given member.
        Parameters:
        member - the member being documented.
        contentTree - the content tree to which the deprecated information will be added.

      • addComment

        protected void addComment​(ProgramElementDoc member,
                          Content htmltree)
        Deprecated.
        Add the comment for the given member.
        Parameters:
        member - the member being documented.
        htmltree - the content tree to which the comment will be added.

      • getHead

        protected Content getHead​(MemberDoc member)
        Deprecated.
        Get the header for the section.
        Parameters:
        member - the member being documented.
        Returns:
        a header content for the section.

      • isInherited

        protected boolean isInherited​(ProgramElementDoc ped)
        Deprecated.
        Return true if the given ProgramElement is inherited by the class that is being documented.
        Parameters:
        ped - The ProgramElement being checked. return true if the ProgramElement is being inherited and false otherwise.

      • addDeprecatedAPI

        protected void addDeprecatedAPI​(List<Doc> deprmembers,
                                String headingKey,
                                String tableSummary,
                                String[] tableHeader,
                                Content contentTree)
        Deprecated.
        Add deprecated information to the documentation tree
        Parameters:
        deprmembers - list of deprecated members
        headingKey - the caption for the deprecated members table
        tableSummary - the summary for the deprecated members table
        tableHeader - table headers for the deprecated members table
        contentTree - the content tree to which the deprecated members table will be added

      • addUseInfo

        protected void addUseInfo​(List<? extends ProgramElementDoc> mems,
                          Content heading,
                          String tableSummary,
                          Content contentTree)
        Deprecated.
        Add use information to the documentation tree.
        Parameters:
        mems - list of program elements for which the use information will be added
        heading - the section heading
        tableSummary - the summary for the use table
        contentTree - the content tree to which the use information will be added

      • addNavDetailLink

        protected void addNavDetailLink​(List<?> members,
                                Content liNav)
        Deprecated.
        Add the navigation detail link.
        Parameters:
        members - the members to be linked
        liNav - the content tree to which the navigation detail link will be added

      • addNavSummaryLink

        protected void addNavSummaryLink​(List<?> members,
                                 VisibleMemberMap visibleMemberMap,
                                 Content liNav)
        Deprecated.
        Add the navigation summary link.
        Parameters:
        members - members to be linked
        visibleMemberMap - the visible inherited members map
        liNav - the content tree to which the navigation summary link will be added

      • addMemberSummary

        public void addMemberSummary​(ClassDoc classDoc,
                             ProgramElementDoc member,
                             Tag[] firstSentenceTags,
                             List<Content> tableContents,
                             int counter)
        Deprecated.
        Add the member summary for the given class.
        Parameters:
        classDoc - the class that is being documented
        member - the member being documented
        firstSentenceTags - the first sentence tags to be added to the summary
        tableContents - the list of contents to which the documentation will be added
        counter - the counter for determining id and style for the table row

      • showTabs

        public boolean showTabs()
        Deprecated.
        Generate the method types set and return true if the method summary table needs to show tabs.
        Returns:
        true if the table should show tabs

      • setSummaryColumnStyle

        public void setSummaryColumnStyle​(HtmlTree tdTree)
        Deprecated.
        Set the style for the summary column.
        Parameters:
        tdTree - the column for which the style will be set

      • addInheritedMemberSummary

        public void addInheritedMemberSummary​(ClassDoc classDoc,
                                      ProgramElementDoc nestedClass,
                                      boolean isFirst,
                                      boolean isLast,
                                      Content linksTree)
        Deprecated.
        Add inherited member summary for the given class and member.
        Parameters:
        classDoc - the class the inherited member belongs to
        nestedClass - the inherited member that is summarized
        isFirst - true if this is the first member in the list
        isLast - true if this is the last member in the list
        linksTree - the content tree to which the summary will be added

      • getInheritedSummaryHeader

        public Content getInheritedSummaryHeader​(ClassDoc classDoc)
        Deprecated.
        Get the inherited summary header for the given class.
        Parameters:
        classDoc - the class the inherited member belongs to
        Returns:
        a content tree for the inherited summary header

      • getInheritedSummaryLinksTree

        public Content getInheritedSummaryLinksTree()
        Deprecated.
        Get the inherited summary links tree.
        Returns:
        a content tree for the inherited summary links

      • getSummaryTableTree

        public Content getSummaryTableTree​(ClassDoc classDoc,
                                   List<Content> tableContents)
        Deprecated.
        Get the summary table tree for the given class.
        Parameters:
        classDoc - the class for which the summary table is generated
        tableContents - list of contents to be displayed in the summary table
        Returns:
        a content tree for the summary table

      • getMemberTree

        public Content getMemberTree​(Content memberTree)
        Deprecated.
        Get the member tree to be documented.
        Parameters:
        memberTree - the content tree of member to be documented
        Returns:
        a content tree that will be added to the class documentation

      • getMemberTree

        public Content getMemberTree​(Content memberTree,
                             boolean isLastContent)
        Deprecated.
        Get the member tree to be documented.
        Parameters:
        memberTree - the content tree of member to be documented
        isLastContent - true if the content to be added is the last content
        Returns:
        a content tree that will be added to the class documentation