duke@1: /*
jjg@1357:  * Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
ohair@554:  * published by the Free Software Foundation.  Oracle designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
ohair@554:  * by Oracle in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
ohair@554:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ohair@554:  * or visit www.oracle.com if you need additional information or have any
ohair@554:  * questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.internal.toolkit.taglets;
duke@1: 
jjg@1357: import com.sun.javadoc.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1: 
duke@1: /**
duke@1:  * A taglet that represents the @return tag.
duke@1:  *
duke@1:  * This code is not part of an API.
duke@1:  * It is implementation that is subject to change.
duke@1:  * Do not use it as an API
duke@1:  *
duke@1:  * @author Jamie Ho
duke@1:  * @since 1.4
duke@1:  */
duke@1: public class ReturnTaglet extends BaseExecutableMemberTaglet
duke@1:         implements InheritableTaglet {
duke@1: 
duke@1:     public ReturnTaglet() {
duke@1:         name = "return";
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void inherit(DocFinder.Input input, DocFinder.Output output) {
duke@1:        Tag[] tags = input.method.tags("return");
duke@1:         if (tags.length > 0) {
duke@1:             output.holder = input.method;
duke@1:             output.holderTag = tags[0];
duke@1:             output.inlineTags = input.isFirstSentence ?
duke@1:                 tags[0].firstSentenceTags() : tags[0].inlineTags();
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return true if this <code>Taglet</code>
duke@1:      * is used in constructor documentation.
duke@1:      * @return true if this <code>Taglet</code>
duke@1:      * is used in constructor documentation and false
duke@1:      * otherwise.
duke@1:      */
duke@1:     public boolean inConstructor() {
duke@1:         return false;
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public TagletOutput getTagletOutput(Doc holder, TagletWriter writer) {
duke@1:         Type returnType = ((MethodDoc) holder).returnType();
duke@1:         Tag[] tags = holder.tags(name);
duke@1: 
duke@1:         //Make sure we are not using @return tag on method with void return type.
duke@1:         if (returnType.isPrimitive() && returnType.typeName().equals("void")) {
duke@1:             if (tags.length > 0) {
duke@1:                 writer.getMsgRetriever().warning(holder.position(),
duke@1:                     "doclet.Return_tag_on_void_method");
duke@1:             }
duke@1:             return null;
duke@1:         }
duke@1:         //Inherit @return tag if necessary.
duke@1:         if (tags.length == 0) {
duke@1:             DocFinder.Output inheritedDoc =
duke@1:                 DocFinder.search(new DocFinder.Input((MethodDoc) holder, this));
duke@1:             tags = inheritedDoc.holderTag == null ? tags : new Tag[] {inheritedDoc.holderTag};
duke@1:         }
duke@1:         return tags.length > 0 ? writer.returnTagOutput(tags[0]) : null;
duke@1:     }
duke@1: }