author | jjg |
Fri, 27 May 2016 13:06:58 -0700 | |
changeset 38617 | d93a7f64e231 |
parent 25874 | 83c19f00452c |
permissions | -rw-r--r-- |
10 | 1 |
/* |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
17574
diff
changeset
|
2 |
* Copyright (c) 2001, 2014, Oracle and/or its affiliates. All rights reserved. |
10 | 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 |
|
5520 | 7 |
* published by the Free Software Foundation. Oracle designates this |
10 | 8 |
* particular file as subject to the "Classpath" exception as provided |
5520 | 9 |
* by Oracle in the LICENSE file that accompanied this code. |
10 | 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 |
* |
|
5520 | 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. |
|
10 | 24 |
*/ |
25 |
||
26 |
package com.sun.tools.doclets.internal.toolkit.taglets; |
|
27 |
||
14258 | 28 |
import com.sun.javadoc.*; |
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
29 |
import com.sun.tools.doclets.internal.toolkit.Content; |
10 | 30 |
import com.sun.tools.doclets.internal.toolkit.util.*; |
31 |
||
32 |
/** |
|
33 |
* A taglet that represents the @return tag. |
|
34 |
* |
|
14260
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
35 |
* <p><b>This is NOT part of any supported API. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
36 |
* If you write code that depends on this, you do so at your own risk. |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
37 |
* This code and its internal interfaces are subject to change or |
727a84636f12
8000665: fix "internal API" comments on javadoc files
jjg
parents:
14258
diff
changeset
|
38 |
* deletion without notice.</b> |
10 | 39 |
* |
40 |
* @author Jamie Ho |
|
41 |
* @since 1.4 |
|
42 |
*/ |
|
38617 | 43 |
@Deprecated |
10 | 44 |
public class ReturnTaglet extends BaseExecutableMemberTaglet |
45 |
implements InheritableTaglet { |
|
46 |
||
47 |
public ReturnTaglet() { |
|
48 |
name = "return"; |
|
49 |
} |
|
50 |
||
51 |
/** |
|
52 |
* {@inheritDoc} |
|
53 |
*/ |
|
54 |
public void inherit(DocFinder.Input input, DocFinder.Output output) { |
|
17547
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
14260
diff
changeset
|
55 |
Tag[] tags = input.element.tags("return"); |
10 | 56 |
if (tags.length > 0) { |
17547
40f2f9a5a445
8008768: Using {@inheritDoc} in simple tag defined via -tag fails
jjg
parents:
14260
diff
changeset
|
57 |
output.holder = input.element; |
10 | 58 |
output.holderTag = tags[0]; |
59 |
output.inlineTags = input.isFirstSentence ? |
|
60 |
tags[0].firstSentenceTags() : tags[0].inlineTags(); |
|
61 |
} |
|
62 |
} |
|
63 |
||
64 |
/** |
|
65 |
* Return true if this <code>Taglet</code> |
|
66 |
* is used in constructor documentation. |
|
67 |
* @return true if this <code>Taglet</code> |
|
68 |
* is used in constructor documentation and false |
|
69 |
* otherwise. |
|
70 |
*/ |
|
71 |
public boolean inConstructor() { |
|
72 |
return false; |
|
73 |
} |
|
74 |
||
75 |
/** |
|
76 |
* {@inheritDoc} |
|
77 |
*/ |
|
17574
044c7e1e4d53
8012308: Remove TagletOutput in favor of direct use of Content
jjg
parents:
17547
diff
changeset
|
78 |
public Content getTagletOutput(Doc holder, TagletWriter writer) { |
10 | 79 |
Type returnType = ((MethodDoc) holder).returnType(); |
80 |
Tag[] tags = holder.tags(name); |
|
81 |
||
82 |
//Make sure we are not using @return tag on method with void return type. |
|
83 |
if (returnType.isPrimitive() && returnType.typeName().equals("void")) { |
|
84 |
if (tags.length > 0) { |
|
85 |
writer.getMsgRetriever().warning(holder.position(), |
|
86 |
"doclet.Return_tag_on_void_method"); |
|
87 |
} |
|
88 |
return null; |
|
89 |
} |
|
90 |
//Inherit @return tag if necessary. |
|
91 |
if (tags.length == 0) { |
|
92 |
DocFinder.Output inheritedDoc = |
|
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
17574
diff
changeset
|
93 |
DocFinder.search(writer.configuration(), new DocFinder.Input((MethodDoc) holder, this)); |
10 | 94 |
tags = inheritedDoc.holderTag == null ? tags : new Tag[] {inheritedDoc.holderTag}; |
95 |
} |
|
96 |
return tags.length > 0 ? writer.returnTagOutput(tags[0]) : null; |
|
97 |
} |
|
98 |
} |