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

     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 @return tag.

    33  *

    34  *  <p><b>This is NOT part of any supported API.

    35  *  If you write code that depends on this, you do so at your own risk.

    36  *  This code and its internal interfaces are subject to change or

    37  *  deletion without notice.</b>

    38  *

    39  * @author Jamie Ho

    40  * @since 1.4

    41  */

    42 public class ReturnTaglet extends BaseExecutableMemberTaglet

    43         implements InheritableTaglet {

    45     public ReturnTaglet() {

    46         name = "return";

    47     }

    49     /**

    50      * {@inheritDoc}

    51      */

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

    53        Tag[] tags = input.method.tags("return");

    54         if (tags.length > 0) {

    55             output.holder = input.method;

    56             output.holderTag = tags[0];

    57             output.inlineTags = input.isFirstSentence ?

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

    59         }

    60     }

    62     /**

    63      * Return true if this <code>Taglet</code>

    64      * is used in constructor documentation.

    65      * @return true if this <code>Taglet</code>

    66      * is used in constructor documentation and false

    67      * otherwise.

    68      */

    69     public boolean inConstructor() {

    70         return false;

    71     }

    73     /**

    74      * {@inheritDoc}

    75      */

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

    77         Type returnType = ((MethodDoc) holder).returnType();

    78         Tag[] tags = holder.tags(name);

    80         //Make sure we are not using @return tag on method with void return type.

    81         if (returnType.isPrimitive() && returnType.typeName().equals("void")) {

    82             if (tags.length > 0) {

    83                 writer.getMsgRetriever().warning(holder.position(),

    84                     "doclet.Return_tag_on_void_method");

    85             }

    86             return null;

    87         }

    88         //Inherit @return tag if necessary.

    89         if (tags.length == 0) {

    90             DocFinder.Output inheritedDoc =

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

    92             tags = inheritedDoc.holderTag == null ? tags : new Tag[] {inheritedDoc.holderTag};

    93         }

    94         return tags.length > 0 ? writer.returnTagOutput(tags[0]) : null;

    95     }

    96 }

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