Class DocRootTaglet

  • All Implemented Interfaces:
    Taglet

    @Deprecated
    public class DocRootTaglet
    extends BaseInlineTaglet
    Deprecated.
    An inline Taglet representing {@docRoot}. This taglet is used to get the relative path to the document's root output directory.

    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.4
    Author:
    Jamie Ho, Doug Kramer
    • Constructor Detail

      • DocRootTaglet

        public DocRootTaglet()
        Deprecated.
        Construct a new DocRootTaglet.
    • Method Detail

      • getTagletOutput

        public Content getTagletOutput​(Tag tag,
                                       TagletWriter writer)
        Deprecated.
        Given a Doc object, check if it holds any tags of this type. If it does, return the string representing the output. If it does not, return null.
        Specified by:
        getTagletOutput in interface Taglet
        Overrides:
        getTagletOutput in class BaseTaglet
        Parameters:
        tag - a tag representing the custom tag.
        writer - a TagletWriter Taglet writer.
        Returns:
        the string representation of this Tag.