Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/DocRootTaglet.java@24a47c3062fe (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/DocRootTaglet.java
Thu, 02 Oct 2008 19:58:40 -0700
- author
- xdono
- date
- Thu, 02 Oct 2008 19:58:40 -0700
- changeset 117
- 24a47c3062fe
- parent 1
- 9a66ca7c79fa
- child 554
- 9d9f26857129
- permissions
- -rw-r--r--
6754988: Update copyright year
Summary: Update for files that have been modified starting July 2008
Reviewed-by: ohair, tbell
| duke@1 | 1 | /* |
| duke@1 | 2 | * Copyright 2001-2003 Sun Microsystems, Inc. All Rights Reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| duke@1 | 9 | * by Sun in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
| duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
| duke@1 | 23 | * have any questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.doclets.internal.toolkit.taglets; |
| duke@1 | 27 | |
| duke@1 | 28 | import com.sun.javadoc.*; |
| duke@1 | 29 | |
| duke@1 | 30 | /** |
| duke@1 | 31 | * An inline Taglet representing {@docRoot}. This taglet is |
| duke@1 | 32 | * used to get the relative path to the document's root output |
| duke@1 | 33 | * directory. |
| duke@1 | 34 | * |
| duke@1 | 35 | * This code is not part of an API. |
| duke@1 | 36 | * It is implementation that is subject to change. |
| duke@1 | 37 | * Do not use it as an API |
| duke@1 | 38 | * |
| duke@1 | 39 | * @author Jamie Ho |
| duke@1 | 40 | * @author Doug Kramer |
| duke@1 | 41 | * @since 1.4 |
| duke@1 | 42 | */ |
| duke@1 | 43 | |
| duke@1 | 44 | public class DocRootTaglet extends BaseInlineTaglet { |
| duke@1 | 45 | |
| duke@1 | 46 | |
| duke@1 | 47 | /** |
| duke@1 | 48 | * Construct a new DocRootTaglet. |
| duke@1 | 49 | */ |
| duke@1 | 50 | public DocRootTaglet() { |
| duke@1 | 51 | name = "docRoot"; |
| duke@1 | 52 | } |
| duke@1 | 53 | |
| duke@1 | 54 | /** |
| duke@1 | 55 | * Given a <code>Doc</code> object, check if it holds any tags of |
| duke@1 | 56 | * this type. If it does, return the string representing the output. |
| duke@1 | 57 | * If it does not, return null. |
| duke@1 | 58 | * @param tag a tag representing the custom tag. |
| duke@1 | 59 | * @param writer a {@link TagletWriter} Taglet writer. |
| duke@1 | 60 | * @return the string representation of this <code>Tag</code>. |
| duke@1 | 61 | */ |
| duke@1 | 62 | public TagletOutput getTagletOutput(Tag tag, TagletWriter writer) { |
| duke@1 | 63 | return writer.getDocRootOutput(); |
| duke@1 | 64 | } |
| duke@1 | 65 | } |
