Class CodeTaglet

  • All Implemented Interfaces:
    Taglet

    @Deprecated
    public class CodeTaglet
    extends BaseInlineTaglet
    Deprecated.
    An inline Taglet used to denote literal code fragments. The enclosed text is interpreted as not containing HTML markup or nested javadoc tags, and is rendered in a font suitable for code.

    The tag {@code ...} is equivalent to <code>{@literal ...}</code>. For example, the text:

    The type {@code List<P>}
    displays as:
    The type List<P>

    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:
    Scott Seligman
    • Constructor Detail

      • CodeTaglet

        public CodeTaglet()
        Deprecated.
    • Method Detail

      • register

        public static void register​(Map<String,​Taglet> map)
        Deprecated.
      • getName

        public String getName()
        Deprecated.
        Description copied from class: BaseTaglet
        Return the name of this custom tag.
        Specified by:
        getName in interface Taglet
        Overrides:
        getName in class BaseTaglet
        Returns:
        the name of this custom tag.
      • getTagletOutput

        public Content getTagletOutput​(Tag tag,
                                       TagletWriter writer)
        Deprecated.
        Given the Tag representation of this custom tag, return its Content representation, which is output to the generated page.
        Specified by:
        getTagletOutput in interface Taglet
        Overrides:
        getTagletOutput in class BaseTaglet
        Parameters:
        tag - the Tag representation of this custom tag.
        writer - a TagletWriter Taglet writer.
        Returns:
        the Content representation of this Tag.