Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/ReturnTaglet.java@25e14ad23cef (annotated)
src/share/classes/com/sun/tools/doclets/internal/toolkit/taglets/ReturnTaglet.java
Wed, 10 Oct 2012 16:48:21 -0700
- author
- jjg
- date
- Wed, 10 Oct 2012 16:48:21 -0700
- changeset 1359
- 25e14ad23cef
- parent 1357
- c75be5bc5283
- child 1724
- d918b63a5509
- permissions
- -rw-r--r--
8000665: fix "internal API" comments on javadoc files
Reviewed-by: darcy
| duke@1 | 1 | /* |
| jjg@1357 | 2 | * Copyright (c) 2001, 2012, Oracle and/or its affiliates. All rights reserved. |
| duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| duke@1 | 4 | * |
| duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
| duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
| duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
| ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| duke@1 | 10 | * |
| duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| duke@1 | 15 | * accompanied this code). |
| duke@1 | 16 | * |
| duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
| duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| duke@1 | 20 | * |
| ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
| ohair@554 | 23 | * questions. |
| duke@1 | 24 | */ |
| duke@1 | 25 | |
| duke@1 | 26 | package com.sun.tools.doclets.internal.toolkit.taglets; |
| duke@1 | 27 | |
| jjg@1357 | 28 | import com.sun.javadoc.*; |
| duke@1 | 29 | import com.sun.tools.doclets.internal.toolkit.util.*; |
| duke@1 | 30 | |
| duke@1 | 31 | /** |
| duke@1 | 32 | * A taglet that represents the @return tag. |
| duke@1 | 33 | * |
| jjg@1359 | 34 | * <p><b>This is NOT part of any supported API. |
| jjg@1359 | 35 | * If you write code that depends on this, you do so at your own risk. |
| jjg@1359 | 36 | * This code and its internal interfaces are subject to change or |
| jjg@1359 | 37 | * deletion without notice.</b> |
| duke@1 | 38 | * |
| duke@1 | 39 | * @author Jamie Ho |
| duke@1 | 40 | * @since 1.4 |
| duke@1 | 41 | */ |
| duke@1 | 42 | public class ReturnTaglet extends BaseExecutableMemberTaglet |
| duke@1 | 43 | implements InheritableTaglet { |
| duke@1 | 44 | |
| duke@1 | 45 | public ReturnTaglet() { |
| duke@1 | 46 | name = "return"; |
| duke@1 | 47 | } |
| duke@1 | 48 | |
| duke@1 | 49 | /** |
| duke@1 | 50 | * {@inheritDoc} |
| duke@1 | 51 | */ |
| duke@1 | 52 | public void inherit(DocFinder.Input input, DocFinder.Output output) { |
| duke@1 | 53 | Tag[] tags = input.method.tags("return"); |
| duke@1 | 54 | if (tags.length > 0) { |
| duke@1 | 55 | output.holder = input.method; |
| duke@1 | 56 | output.holderTag = tags[0]; |
| duke@1 | 57 | output.inlineTags = input.isFirstSentence ? |
| duke@1 | 58 | tags[0].firstSentenceTags() : tags[0].inlineTags(); |
| duke@1 | 59 | } |
| duke@1 | 60 | } |
| duke@1 | 61 | |
| duke@1 | 62 | /** |
| duke@1 | 63 | * Return true if this <code>Taglet</code> |
| duke@1 | 64 | * is used in constructor documentation. |
| duke@1 | 65 | * @return true if this <code>Taglet</code> |
| duke@1 | 66 | * is used in constructor documentation and false |
| duke@1 | 67 | * otherwise. |
| duke@1 | 68 | */ |
| duke@1 | 69 | public boolean inConstructor() { |
| duke@1 | 70 | return false; |
| duke@1 | 71 | } |
| duke@1 | 72 | |
| duke@1 | 73 | /** |
| duke@1 | 74 | * {@inheritDoc} |
| duke@1 | 75 | */ |
| duke@1 | 76 | public TagletOutput getTagletOutput(Doc holder, TagletWriter writer) { |
| duke@1 | 77 | Type returnType = ((MethodDoc) holder).returnType(); |
| duke@1 | 78 | Tag[] tags = holder.tags(name); |
| duke@1 | 79 | |
| duke@1 | 80 | //Make sure we are not using @return tag on method with void return type. |
| duke@1 | 81 | if (returnType.isPrimitive() && returnType.typeName().equals("void")) { |
| duke@1 | 82 | if (tags.length > 0) { |
| duke@1 | 83 | writer.getMsgRetriever().warning(holder.position(), |
| duke@1 | 84 | "doclet.Return_tag_on_void_method"); |
| duke@1 | 85 | } |
| duke@1 | 86 | return null; |
| duke@1 | 87 | } |
| duke@1 | 88 | //Inherit @return tag if necessary. |
| duke@1 | 89 | if (tags.length == 0) { |
| duke@1 | 90 | DocFinder.Output inheritedDoc = |
| duke@1 | 91 | DocFinder.search(new DocFinder.Input((MethodDoc) holder, this)); |
| duke@1 | 92 | tags = inheritedDoc.holderTag == null ? tags : new Tag[] {inheritedDoc.holderTag}; |
| duke@1 | 93 | } |
| duke@1 | 94 | return tags.length > 0 ? writer.returnTagOutput(tags[0]) : null; |
| duke@1 | 95 | } |
| duke@1 | 96 | } |
