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

     1 /*

     2  * Copyright (c) 2001, 2012, 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  */

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

    28 import com.sun.javadoc.*;

    29 import com.sun.tools.doclets.internal.toolkit.util.*;

    31 /**

    32  * A taglet that represents the @see tag.

    33  *

    34  * This code is not part of an API.

    35  * It is implementation that is subject to change.

    36  * Do not use it as an API

    37  *

    38  * @author Jamie Ho

    39  * @since 1.4

    40  */

    41 public class SeeTaglet extends BaseTaglet implements InheritableTaglet {

    43     public SeeTaglet() {

    44         name = "see";

    45     }

    47     /**

    48      * {@inheritDoc}

    49      */

    50     public void inherit(DocFinder.Input input, DocFinder.Output output) {

    51         Tag[] tags = input.method.seeTags();

    52         if (tags.length > 0) {

    53             output.holder = input.method;

    54             output.holderTag = tags[0];

    55             output.inlineTags = input.isFirstSentence ?

    56                 tags[0].firstSentenceTags() : tags[0].inlineTags();

    57         }

    58     }

    60     /**

    61      * {@inheritDoc}

    62      */

    63     public TagletOutput getTagletOutput(Doc holder, TagletWriter writer) {

    64         SeeTag[] tags = holder.seeTags();

    65         if (tags.length == 0 && holder instanceof MethodDoc) {

    66             DocFinder.Output inheritedDoc =

    67                 DocFinder.search(new DocFinder.Input((MethodDoc) holder, this));

    68             if (inheritedDoc.holder != null) {

    69                 tags = inheritedDoc.holder.seeTags();

    70             }

    71         }

    72         return writer.seeTagOutput(holder, tags);

    73     }

    74 }

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