1 /*
   2  * Copyright (c) 2001, 2013, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package com.sun.tools.doclets.internal.toolkit.taglets;
  27 
  28 import com.sun.javadoc.*;
  29 import com.sun.tools.doclets.internal.toolkit.Content;
  30 
  31 /**
  32  * An inline Taglet representing {@docRoot}.  This taglet is
  33  * used to get the relative path to the document's root output
  34  * directory.
  35  *
  36  *  <p><b>This is NOT part of any supported API.
  37  *  If you write code that depends on this, you do so at your own risk.
  38  *  This code and its internal interfaces are subject to change or
  39  *  deletion without notice.</b>
  40  *
  41  * @author Jamie Ho
  42  * @author Doug Kramer
  43  * @since 1.4
  44  */
  45 
  46 public class DocRootTaglet extends BaseInlineTaglet {
  47 
  48 
  49     /**
  50      * Construct a new DocRootTaglet.
  51      */
  52     public DocRootTaglet() {
  53         name = "docRoot";
  54     }
  55 
  56     /**
  57      * Given a <code>Doc</code> object, check if it holds any tags of
  58      * this type.  If it does, return the string representing the output.
  59      * If it does not, return null.
  60      * @param tag a tag representing the custom tag.
  61      * @param writer a {@link TagletWriter} Taglet writer.
  62      * @return the string representation of this <code>Tag</code>.
  63      */
  64     public Content getTagletOutput(Tag tag, TagletWriter writer) {
  65         return writer.getDocRootOutput();
  66     }
  67 }