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

8012308: Remove TagletOutput in favor of direct use of Content
Reviewed-by: darcy

     1 /*

     2  * Copyright (c) 2001, 2013, 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.Content;

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

    32 /**

    33  * A taglet that represents the @return tag.

    34  *

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

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

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

    38  *  deletion without notice.</b>

    39  *

    40  * @author Jamie Ho

    41  * @since 1.4

    42  */

    43 public class ReturnTaglet extends BaseExecutableMemberTaglet

    44         implements InheritableTaglet {

    46     public ReturnTaglet() {

    47         name = "return";

    48     }

    50     /**

    51      * {@inheritDoc}

    52      */

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

    54        Tag[] tags = input.element.tags("return");

    55         if (tags.length > 0) {

    56             output.holder = input.element;

    57             output.holderTag = tags[0];

    58             output.inlineTags = input.isFirstSentence ?

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

    60         }

    61     }

    63     /**

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

    65      * is used in constructor documentation.

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

    67      * is used in constructor documentation and false

    68      * otherwise.

    69      */

    70     public boolean inConstructor() {

    71         return false;

    72     }

    74     /**

    75      * {@inheritDoc}

    76      */

    77     public Content getTagletOutput(Doc holder, TagletWriter writer) {

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

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

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

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

    83             if (tags.length > 0) {

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

    85                     "doclet.Return_tag_on_void_method");

    86             }

    87             return null;

    88         }

    89         //Inherit @return tag if necessary.

    90         if (tags.length == 0) {

    91             DocFinder.Output inheritedDoc =

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

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

    94         }

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

    96     }

    97 }

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