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

Class TagletWriterImpl

java.lang.Object
gw.gosudoc.com.sun.tools.doclets.internal.toolkit.taglets.TagletWriter
gw.gosudoc.com.sun.tools.doclets.formats.html.TagletWriterImpl
@Deprecated public class TagletWriterImpl extends TagletWriter
Deprecated.
The taglet writer that writes HTML.

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

  • Field Details

  • Constructor Details

    • TagletWriterImpl

      public TagletWriterImpl(HtmlDocletWriter htmlWriter, boolean isFirstSentence)
      Deprecated.

  • Method Details

    • getOutputInstance

      public Content getOutputInstance()
      Deprecated.
      Specified by:
      getOutputInstance in class TagletWriter
      Returns:
      an instance of an output object.

    • codeTagOutput

      protected Content codeTagOutput(Tag tag)
      Deprecated.
      Return the output for a {@code ...} tag.
      Specified by:
      codeTagOutput in class TagletWriter
      Parameters:
      tag - the tag.
      Returns:
      the output of the taglet.

    • indexTagOutput

      protected Content indexTagOutput(Tag tag)
      Deprecated.
      Description copied from class: TagletWriter
      Return the output for a tag.
      Specified by:
      indexTagOutput in class TagletWriter
      Parameters:
      tag - the tag.
      Returns:
      the output of the taglet.

    • getDocRootOutput

      public Content getDocRootOutput()
      Deprecated.
      Returns the output for the DocRoot inline tag.
      Specified by:
      getDocRootOutput in class TagletWriter
      Returns:
      the output for the DocRoot inline tag.

    • deprecatedTagOutput

      public Content deprecatedTagOutput(Doc doc)
      Deprecated.
      Return the deprecated tag output.
      Specified by:
      deprecatedTagOutput in class TagletWriter
      Parameters:
      doc - the doc to write deprecated documentation for.
      Returns:
      the output of the deprecated tag.

    • literalTagOutput

      protected Content literalTagOutput(Tag tag)
      Deprecated.
      Return the output for a {@literal ...} tag.
      Specified by:
      literalTagOutput in class TagletWriter
      Parameters:
      tag - the tag.
      Returns:
      the output of the taglet.

    • getMsgRetriever

      public MessageRetriever getMsgRetriever()
      Deprecated.
      Returns MessageRetriever for output purposes.
      Specified by:
      getMsgRetriever in class TagletWriter
      Returns:
      MessageRetriever for output purposes.

    • getParamHeader

      public Content getParamHeader(String header)
      Deprecated.
      Return the header for the param tags.
      Specified by:
      getParamHeader in class TagletWriter
      Parameters:
      header - the header to display.
      Returns:
      the header for the param tags.

    • paramTagOutput

      public Content paramTagOutput(ParamTag paramTag, String paramName)
      Deprecated.
      Return the output for param tags.
      Specified by:
      paramTagOutput in class TagletWriter
      Parameters:
      paramTag - the parameter to document.
      paramName - the name of the parameter.
      Returns:
      the output of the param tag.

    • propertyTagOutput

      public Content propertyTagOutput(Tag tag, String prefix)
      Deprecated.
      Return the output for property tags.
      Specified by:
      propertyTagOutput in class TagletWriter
      Parameters:
      tag - the parameter to document.
      prefix - the text with which to prefix the property name.
      Returns:
      the output of the param tag.

    • returnTagOutput

      public Content returnTagOutput(Tag returnTag)
      Deprecated.
      Return the return tag output.
      Specified by:
      returnTagOutput in class TagletWriter
      Parameters:
      returnTag - the return tag to output.
      Returns:
      the output of the return tag.

    • seeTagOutput

      public Content seeTagOutput(Doc holder, SeeTag[] seeTags)
      Deprecated.
      Return the see tag output.
      Specified by:
      seeTagOutput in class TagletWriter
      seeTags - the array of See tags.
      Returns:
      the output of the see tags.

    • appendSeparatorIfNotEmpty

      private void appendSeparatorIfNotEmpty(ContentBuilder body)
      Deprecated.

    • simpleTagOutput

      public Content simpleTagOutput(Tag[] simpleTags, String header)
      Deprecated.
      Return the output for a simple tag.
      Specified by:
      simpleTagOutput in class TagletWriter
      Parameters:
      simpleTags - the array of simple tags.
      Returns:
      the output of the simple tags.

    • simpleTagOutput

      public Content simpleTagOutput(Tag simpleTag, String header)
      Deprecated.
      Return the output for a simple tag.
      Specified by:
      simpleTagOutput in class TagletWriter
      Parameters:
      simpleTag - the simple tag.
      Returns:
      the output of the simple tag.

    • getThrowsHeader

      public Content getThrowsHeader()
      Deprecated.
      Return the header for the throws tag.
      Specified by:
      getThrowsHeader in class TagletWriter
      Returns:
      the header for the throws tag.

    • throwsTagOutput

      public Content throwsTagOutput(ThrowsTag throwsTag)
      Deprecated.
      Return the header for the throws tag.
      Specified by:
      throwsTagOutput in class TagletWriter
      Parameters:
      throwsTag - the throws tag.
      Returns:
      the output of the throws tag.

    • throwsTagOutput

      public Content throwsTagOutput(Type throwsType)
      Deprecated.
      Return the output for the throws tag.
      Specified by:
      throwsTagOutput in class TagletWriter
      Parameters:
      throwsType - the throws type.
      Returns:
      the output of the throws type.

    • valueTagOutput

      public Content valueTagOutput(FieldDoc field, String constantVal, boolean includeLink)
      Deprecated.
      Return the output for the value tag.
      Specified by:
      valueTagOutput in class TagletWriter
      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.

    • commentTagsToOutput

      public 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.
      Specified by:
      commentTagsToOutput in class TagletWriter
      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 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.
      Specified by:
      commentTagsToOutput in class TagletWriter
      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 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.
      Specified by:
      commentTagsToOutput in class TagletWriter
      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 Configuration configuration()
      Deprecated.
      Specified by:
      configuration in class TagletWriter
      Returns:
      an instance of the configuration used for this doclet.