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

Class AnnotationTypeWriterImpl

    • Field Detail

      • prev

        protected Type prev
        Deprecated.

      • next

        protected Type next
        Deprecated.

    • Constructor Detail

      • AnnotationTypeWriterImpl

        public AnnotationTypeWriterImpl​(ConfigurationImpl configuration,
                                AnnotationTypeDoc annotationType,
                                Type prevType,
                                Type nextType)
                         throws Exception
        Deprecated.
        Parameters:
        annotationType - the annotation type being documented.
        prevType - the previous class that was documented.
        nextType - the next class being documented.
        Throws:
        Exception

    • Method Detail

      • getNavLinkPrevious

        public Content getNavLinkPrevious()
        Deprecated.
        Get link to previous class.
        Overrides:
        getNavLinkPrevious in class HtmlDocletWriter
        Returns:
        a content tree for the previous class link

      • getNavLinkNext

        public Content getNavLinkNext()
        Deprecated.
        Get link to next class.
        Overrides:
        getNavLinkNext in class HtmlDocletWriter
        Returns:
        a content tree for the next class link

      • getHeader

        public Content getHeader​(String header)
        Deprecated.
        Get the header of the page.
        Specified by:
        getHeader in interface AnnotationTypeWriter
        Parameters:
        header - the header string to write
        Returns:
        a content tree for the header documentation

      • getAnnotationContentHeader

        public Content getAnnotationContentHeader()
        Deprecated.
        Get the annotation content header.
        Specified by:
        getAnnotationContentHeader in interface AnnotationTypeWriter
        Returns:
        annotation content header that needs to be added to the documentation

      • addFooter

        public void addFooter​(Content contentTree)
        Deprecated.
        Add the footer of the page.
        Specified by:
        addFooter in interface AnnotationTypeWriter
        Parameters:
        contentTree - content tree to which the footer will be added

      • getAnnotationInfoTreeHeader

        public Content getAnnotationInfoTreeHeader()
        Deprecated.
        Get the annotation information tree header.
        Specified by:
        getAnnotationInfoTreeHeader in interface AnnotationTypeWriter
        Returns:
        annotation information tree header that needs to be added to the documentation

      • getAnnotationInfo

        public Content getAnnotationInfo​(Content annotationInfoTree)
        Deprecated.
        Get the annotation information.
        Specified by:
        getAnnotationInfo in interface AnnotationTypeWriter
        Parameters:
        annotationInfoTree - content tree containing the annotation information
        Returns:
        a content tree for the annotation

      • addAnnotationTypeSignature

        public void addAnnotationTypeSignature​(String modifiers,
                                       Content annotationInfoTree)
        Deprecated.
        Add the signature of the current annotation type.
        Specified by:
        addAnnotationTypeSignature in interface AnnotationTypeWriter
        Parameters:
        modifiers - the modifiers for the signature
        annotationInfoTree - the annotation content tree to which the signature will be added

      • addAnnotationTypeDescription

        public void addAnnotationTypeDescription​(Content annotationInfoTree)
        Deprecated.
        Build the annotation type description.
        Specified by:
        addAnnotationTypeDescription in interface AnnotationTypeWriter
        Parameters:
        annotationInfoTree - content tree to which the description will be added

      • addAnnotationTypeTagInfo

        public void addAnnotationTypeTagInfo​(Content annotationInfoTree)
        Deprecated.
        Add the tag information for the current annotation type.
        Specified by:
        addAnnotationTypeTagInfo in interface AnnotationTypeWriter
        Parameters:
        annotationInfoTree - content tree to which the tag information will be added

      • addAnnotationTypeDeprecationInfo

        public void addAnnotationTypeDeprecationInfo​(Content annotationInfoTree)
        Deprecated.
        If this annotation is deprecated, add the appropriate information.
        Specified by:
        addAnnotationTypeDeprecationInfo in interface AnnotationTypeWriter
        Parameters:
        annotationInfoTree - content tree to which the deprecated information will be added

      • getNavLinkTree

        protected Content getNavLinkTree()
        Deprecated.
        Get "Tree" link in the navigation bar. If there is only one package specified on the command line, then the "Tree" link will be to the only "package-tree.html" file otherwise it will be to the "overview-tree.html" file.
        Overrides:
        getNavLinkTree in class HtmlDocletWriter
        Returns:
        a content tree for the link

      • addSummaryDetailLinks

        protected void addSummaryDetailLinks​(Content subDiv)
        Deprecated.
        Add summary details to the navigation bar.
        Overrides:
        addSummaryDetailLinks in class HtmlDocletWriter
        Parameters:
        subDiv - the content tree to which the summary detail links will be added

      • getNavSummaryLinks

        protected Content getNavSummaryLinks()
                              throws Exception
        Deprecated.
        Get summary links for navigation bar.
        Returns:
        the content tree for the navigation summary links
        Throws:
        Exception

      • addNavSummaryLink

        protected void addNavSummaryLink​(MemberSummaryBuilder builder,
                                 String label,
                                 int type,
                                 Content liNav)
        Deprecated.
        Add the navigation summary link.
        Parameters:
        builder - builder for the member to be documented
        label - the label for the navigation
        type - type to be documented
        liNav - the content tree to which the navigation summary link will be added

      • getNavDetailLinks

        protected Content getNavDetailLinks()
                             throws Exception
        Deprecated.
        Get detail links for the navigation bar.
        Returns:
        the content tree for the detail links
        Throws:
        Exception

      • addNavGap

        protected void addNavGap​(Content liNav)
        Deprecated.
        Add gap between navigation bar elements.
        Parameters:
        liNav - the content tree to which the gap will be added