Class TagletWriter

  • Direct Known Subclasses:
    TagletWriterImpl

    @Deprecated
    public abstract class TagletWriter
    extends Object
    Deprecated.
    The interface for the taglet writer.

    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.5
    Author:
    Jamie Ho
    • Field Detail

      • isFirstSentence

        protected final boolean isFirstSentence
        Deprecated.
        True if we only want to write the first sentence.
    • Constructor Detail

      • TagletWriter

        protected TagletWriter​(boolean isFirstSentence)
        Deprecated.
    • Method Detail

      • getOutputInstance

        public abstract Content getOutputInstance()
        Deprecated.
        Returns:
        an instance of an output object.
      • codeTagOutput

        protected abstract Content codeTagOutput​(Tag tag)
        Deprecated.
        Return the output for a {@code ...} tag.
        Parameters:
        tag - the tag.
        Returns:
        the output of the taglet.
      • indexTagOutput

        protected abstract Content indexTagOutput​(Tag tag)
        Deprecated.
        Return the output for a tag.
        Parameters:
        tag - the tag.
        Returns:
        the output of the taglet.
      • getDocRootOutput

        protected abstract Content getDocRootOutput()
        Deprecated.
        Returns the output for the DocRoot inline tag.
        Returns:
        the output for the DocRoot inline tag.
      • deprecatedTagOutput

        protected abstract Content deprecatedTagOutput​(Doc doc)
        Deprecated.
        Return the deprecated tag output.
        Parameters:
        doc - the doc to write deprecated documentation for.
        Returns:
        the output of the deprecated tag.
      • literalTagOutput

        protected abstract Content literalTagOutput​(Tag tag)
        Deprecated.
        Return the output for a {@literal ...} tag.
        Parameters:
        tag - the tag.
        Returns:
        the output of the taglet.
      • getParamHeader

        protected abstract Content getParamHeader​(String header)
        Deprecated.
        Return the header for the param tags.
        Parameters:
        header - the header to display.
        Returns:
        the header for the param tags.
      • paramTagOutput

        protected abstract Content paramTagOutput​(ParamTag paramTag,
                                                  String paramName)
        Deprecated.
        Return the output for param tags.
        Parameters:
        paramTag - the parameter to document.
        paramName - the name of the parameter.
        Returns:
        the output of the param tag.
      • propertyTagOutput

        protected abstract Content propertyTagOutput​(Tag propertyTag,
                                                     String prefix)
        Deprecated.
        Return the output for property tags.
        Parameters:
        propertyTag - the parameter to document.
        prefix - the text with which to prefix the property name.
        Returns:
        the output of the param tag.
      • returnTagOutput

        protected abstract Content returnTagOutput​(Tag returnTag)
        Deprecated.
        Return the return tag output.
        Parameters:
        returnTag - the return tag to output.
        Returns:
        the output of the return tag.
      • seeTagOutput

        protected abstract Content seeTagOutput​(Doc holder,
                                                SeeTag[] seeTags)
        Deprecated.
        Return the see tag output.
        Parameters:
        seeTags - the array of See tags.
        Returns:
        the output of the see tags.
      • simpleTagOutput

        protected abstract Content simpleTagOutput​(Tag[] simpleTags,
                                                   String header)
        Deprecated.
        Return the output for a simple tag.
        Parameters:
        simpleTags - the array of simple tags.
        Returns:
        the output of the simple tags.
      • simpleTagOutput

        protected abstract Content simpleTagOutput​(Tag simpleTag,
                                                   String header)
        Deprecated.
        Return the output for a simple tag.
        Parameters:
        simpleTag - the simple tag.
        Returns:
        the output of the simple tag.
      • getThrowsHeader

        protected abstract Content getThrowsHeader()
        Deprecated.
        Return the header for the throws tag.
        Returns:
        the header for the throws tag.
      • throwsTagOutput

        protected abstract Content throwsTagOutput​(ThrowsTag throwsTag)
        Deprecated.
        Return the header for the throws tag.
        Parameters:
        throwsTag - the throws tag.
        Returns:
        the output of the throws tag.
      • throwsTagOutput

        protected abstract Content throwsTagOutput​(Type throwsType)
        Deprecated.
        Return the output for the throws tag.
        Parameters:
        throwsType - the throws type.
        Returns:
        the output of the throws type.
      • valueTagOutput

        protected abstract Content valueTagOutput​(FieldDoc field,
                                                  String constantVal,
                                                  boolean includeLink)
        Deprecated.
        Return the output for the value tag.
        Parameters:
        field - the constant field that holds the value tag.
        constantVal - the constant value to document.
        includeLink - true if we should link the constant text to the constant field itself.
        Returns:
        the output of the value tag.
      • genTagOuput

        public static void genTagOuput​(TagletManager tagletManager,
                                       Doc doc,
                                       Taglet[] taglets,
                                       TagletWriter writer,
                                       Content output)
        Deprecated.
        Given an output object, append to it the tag documentation for the given member.
        Parameters:
        tagletManager - the manager that manages the taglets.
        doc - the Doc that we are print tags for.
        taglets - the taglets to print.
        writer - the writer that will generate the output strings.
        output - the output buffer to store the output in.
      • getInlineTagOuput

        public static Content getInlineTagOuput​(TagletManager tagletManager,
                                                Tag holderTag,
                                                Tag inlineTag,
                                                TagletWriter tagletWriter)
        Deprecated.
        Given an inline tag, return its output.
        Parameters:
        tagletManager - The taglet manager for the current doclet.
        holderTag - The tag this holds this inline tag. Null if there is no tag that holds it.
        inlineTag - The inline tag to be documented.
        tagletWriter - The taglet writer to write the output.
        Returns:
        The output of the inline tag.
      • commentTagsToOutput

        public abstract Content commentTagsToOutput​(Tag holderTag,
                                                    Tag[] tags)
        Deprecated.
        Converts inline tags and text to TagOutput, expanding the inline tags along the way. Called wherever text can contain an inline tag, such as in comments or in free-form text arguments to non-inline tags.
        Parameters:
        holderTag - the tag that holds the documentation.
        tags - array of text tags and inline tags (often alternating) present in the text of interest for this doc.
        Returns:
        the Content representing the comments.
      • commentTagsToOutput

        public abstract Content commentTagsToOutput​(Doc holderDoc,
                                                    Tag[] tags)
        Deprecated.
        Converts inline tags and text to TagOutput, expanding the inline tags along the way. Called wherever text can contain an inline tag, such as in comments or in free-form text arguments to non-inline tags.
        Parameters:
        holderDoc - specific doc where comment resides.
        tags - array of text tags and inline tags (often alternating) present in the text of interest for this doc.
        Returns:
        the Content representing the comments.
      • commentTagsToOutput

        public abstract Content commentTagsToOutput​(Tag holderTag,
                                                    Doc holderDoc,
                                                    Tag[] tags,
                                                    boolean isFirstSentence)
        Deprecated.
        Converts inline tags and text to TagOutput, expanding the inline tags along the way. Called wherever text can contain an inline tag, such as in comments or in free-form text arguments to non-inline tags.
        Parameters:
        holderTag - the tag that holds the documentation.
        holderDoc - specific doc where comment resides.
        tags - array of text tags and inline tags (often alternating) present in the text of interest for this doc.
        isFirstSentence - true if this is the first sentence.
        Returns:
        the Content representing the comments.
      • configuration

        public abstract Configuration configuration()
        Deprecated.
        Returns:
        an instance of the configuration used for this doclet.