jdk8-mips64-public/langtools: src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/DocRootTaglet.java@24a47c3062fe

6754988: Update copyright year
Summary: Update for files that have been modified starting July 2008
Reviewed-by: ohair, tbell

     1 /*

     2  * Copyright 2001-2003 Sun Microsystems, Inc.  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.  Sun designates this

     8  * particular file as subject to the "Classpath" exception as provided

     9  * 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  */

    26 package com.sun.tools.doclets.internal.toolkit.taglets;

    28 import com.sun.javadoc.*;

    30 /**

    31  * An inline Taglet representing {&#064;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  */

    44 public class DocRootTaglet extends BaseInlineTaglet {

    47     /**

    48      * Construct a new DocRootTaglet.

    49      */

    50     public DocRootTaglet() {

    51         name = "docRoot";

    52     }

    54     /**

    55      * Given a <code>Doc</code> object, check if it holds any tags of

    56      * this type.  If it does, return the string representing the output.

    57      * If it does not, return null.

    58      * @param tag a tag representing the custom tag.

    59      * @param writer a {@link TagletWriter} Taglet writer.

    60      * @return the string representation of this <code>Tag</code>.

    61      */

    62     public TagletOutput getTagletOutput(Tag tag, TagletWriter writer) {

    63         return writer.getDocRootOutput();

    64     }

    65 }

Mercurial > jdk8-mips64-public > langtools / file revision