Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/DocRootTaglet.java@792c40d5185a (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/DocRootTaglet.java
Tue, 18 Jun 2013 20:56:04 -0700
- author
- mfang
- date
- Tue, 18 Jun 2013 20:56:04 -0700
- changeset 1841
- 792c40d5185a
- parent 1751
- ca8808c88f94
- child 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
8015657: jdk8 l10n resource file translation update 3
Reviewed-by: yhuang
| duke@1 | 1 | /* |
| jjg@1751 | 2 | * Copyright (c) 2001, 2013, Oracle and/or its affiliates. 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 |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle 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 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * 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.*; |
| jjg@1751 | 29 | import com.sun.tools.doclets.internal.toolkit.Content; |
| duke@1 | 30 | |
| duke@1 | 31 | /** |
| duke@1 | 32 | * An inline Taglet representing {@docRoot}. This taglet is |
| duke@1 | 33 | * used to get the relative path to the document's root output |
| duke@1 | 34 | * directory. |
| duke@1 | 35 | * |
| jjg@1359 | 36 | * <p><b>This is NOT part of any supported API. |
| jjg@1359 | 37 | * If you write code that depends on this, you do so at your own risk. |
| jjg@1359 | 38 | * This code and its internal interfaces are subject to change or |
| jjg@1359 | 39 | * deletion without notice.</b> |
| duke@1 | 40 | * |
| duke@1 | 41 | * @author Jamie Ho |
| duke@1 | 42 | * @author Doug Kramer |
| duke@1 | 43 | * @since 1.4 |
| duke@1 | 44 | */ |
| duke@1 | 45 | |
| duke@1 | 46 | public class DocRootTaglet extends BaseInlineTaglet { |
| duke@1 | 47 | |
| duke@1 | 48 | |
| duke@1 | 49 | /** |
| duke@1 | 50 | * Construct a new DocRootTaglet. |
| duke@1 | 51 | */ |
| duke@1 | 52 | public DocRootTaglet() { |
| duke@1 | 53 | name = "docRoot"; |
| duke@1 | 54 | } |
| duke@1 | 55 | |
| duke@1 | 56 | /** |
| duke@1 | 57 | * Given a <code>Doc</code> object, check if it holds any tags of |
| duke@1 | 58 | * this type. If it does, return the string representing the output. |
| duke@1 | 59 | * If it does not, return null. |
| duke@1 | 60 | * @param tag a tag representing the custom tag. |
| duke@1 | 61 | * @param writer a {@link TagletWriter} Taglet writer. |
| duke@1 | 62 | * @return the string representation of this <code>Tag</code>. |
| duke@1 | 63 | */ |
| jjg@1751 | 64 | public Content getTagletOutput(Tag tag, TagletWriter writer) { |
| duke@1 | 65 | return writer.getDocRootOutput(); |
| duke@1 | 66 | } |
| duke@1 | 67 | } |
