blob: ba406a6ebadc14619bb507473f8a92d4ffa9814e (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
/* gnu.classpath.tools.taglets.DeprecatedTaglet
Copyright (C) 2001 Free Software Foundation, Inc.
This file is part of GNU Classpath.
GNU Classpath is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2, or (at your option)
any later version.
GNU Classpath is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License
along with GNU Classpath; see the file COPYING. If not, write to the
Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
02111-1307 USA. */
package gnu.classpath.tools.taglets;
import java.util.Map;
import com.sun.tools.doclets.Taglet;
import com.sun.javadoc.Tag;
/**
* The default Taglet which handles deprecated information.
*
* @author Julian Scheid (julian@sektor37.de)
*/
public class DeprecatedTaglet implements Taglet {
private static final String NAME = "deprecated";
private static final String HEADER = "Deprecated:";
private static boolean enabled = true;
public String getName() {
return NAME;
}
public boolean inField() {
return true;
}
public boolean inConstructor() {
return true;
}
public boolean inMethod() {
return true;
}
public boolean inOverview() {
return true;
}
public boolean inPackage() {
return true;
}
public boolean inType() {
return true;
}
public boolean isInlineTag() {
return false;
}
public static void register(Map tagletMap) {
DeprecatedTaglet deprecatedTaglet = new DeprecatedTaglet();
tagletMap.put(deprecatedTaglet.getName(), deprecatedTaglet);
}
public String toString(Tag tag) {
if (enabled) {
return toString(new Tag[] { tag });
}
else {
return null;
}
}
public String toString(Tag[] tags) {
if (!enabled || tags.length == 0) {
return null;
}
else {
StringBuffer result = new StringBuffer();
result.append("<div class=\"classdoc-tag-section-header\">");
result.append(HEADER);
result.append("</div>");
result.append("<dl class=\"classdoc-list\">");
for (int i = 0; i < tags.length; i++) {
result.append("<dt>");
result.append(tags[i].text());
result.append("</dt>");
}
result.append("</dl>");
return result.toString();
}
}
/**
* Enables/disables this taglet.
*/
public static void setTagletEnabled(boolean enabled)
{
DeprecatedTaglet.enabled = enabled;
}
}
|
