01: /*
02: * Copyright 2001-2003 Sun Microsystems, Inc. All Rights Reserved.
03: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
04: *
05: * This code is free software; you can redistribute it and/or modify it
06: * under the terms of the GNU General Public License version 2 only, as
07: * published by the Free Software Foundation. Sun designates this
08: * particular file as subject to the "Classpath" exception as provided
09: * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22: * CA 95054 USA or visit www.sun.com if you need additional information or
23: * have any questions.
24: */
25:
26: package com.sun.tools.doclets.internal.toolkit.taglets;
27:
28: import com.sun.javadoc.*;
29:
30: /**
31: * An inline Taglet representing {@docRoot}. This taglet is
32: * used to get the relative path to the document's root output
33: * directory.
34: *
35: * This code is not part of an API.
36: * It is implementation that is subject to change.
37: * Do not use it as an API
38: *
39: * @author Jamie Ho
40: * @author Doug Kramer
41: * @since 1.4
42: */
43:
44: public class DocRootTaglet extends BaseInlineTaglet {
45:
46: /**
47: * Construct a new DocRootTaglet.
48: */
49: public DocRootTaglet() {
50: name = "docRoot";
51: }
52:
53: /**
54: * Given a <code>Doc</code> object, check if it holds any tags of
55: * this type. If it does, return the string representing the output.
56: * If it does not, return null.
57: * @param tag a tag representing the custom tag.
58: * @param writer a {@link TagletWriter} Taglet writer.
59: * @return the string representation of this <code>Tag</code>.
60: */
61: public TagletOutput getTagletOutput(Tag tag, TagletWriter writer) {
62: return writer.getDocRootOutput();
63: }
64: }
|