blob: ec9f523685898510f92ec8b46b02e3880f833c9d (
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
|
/*
* Copyright (C) 2008 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import java.io.IOException;
import java.io.FileWriter;
import java.util.regex.Pattern;
import java.util.regex.Matcher;
public class Proofread
{
static FileWriter out = null;
static final Pattern WHITESPACE = Pattern.compile("\\r?\\n");
static final String INDENT = " ";
static final String NEWLINE = "\n" + INDENT;
public static void initProofread(String filename)
{
try {
out = new FileWriter(filename);
out.write("javadoc proofread file: " + filename + "\n");
}
catch (IOException e) {
if (out != null) {
try {
out.close();
}
catch (IOException ex) {
}
out = null;
}
System.err.println("error opening file: " + filename);
}
}
public static void finishProofread(String filename)
{
if (out == null) {
return;
}
try {
out.close();
}
catch (IOException e) {
}
}
public static void write(String s)
{
if (out == null) {
return ;
}
try {
out.write(s);
}
catch (IOException e) {
}
}
public static void writeIndented(String s)
{
s = s.trim();
Matcher m = WHITESPACE.matcher(s);
s = m.replaceAll(NEWLINE);
write(INDENT);
write(s);
write("\n");
}
public static void writeFileHeader(String filename)
{
write("\n\n=== ");
write(filename);
write(" ===\n");
}
public static void writeTagList(TagInfo[] tags)
{
if (out == null) {
return;
}
for (TagInfo t: tags) {
String k = t.kind();
if ("Text".equals(t.name())) {
writeIndented(t.text());
}
else if ("@more".equals(k)) {
writeIndented("");
}
else if ("@see".equals(k)) {
SeeTagInfo see = (SeeTagInfo)t;
String label = see.label();
if (label == null) {
label = "";
}
writeIndented("{" + see.name() + " ... " + label + "}");
}
else if ("@code".equals(k)) {
writeIndented(t.text());
}
else if ("@samplecode".equals(k)) {
writeIndented(t.text());
}
else {
writeIndented("{" + (t.name() != null ? t.name() : "") + "/" +
t.text() + "}");
}
}
}
public static void writePackages(String filename, TagInfo[] tags)
{
if (out == null) {
return;
}
writeFileHeader(filename);
writeTagList(tags);
}
public static void writePackage(String filename, TagInfo[] tags)
{
if (out == null) {
return;
}
writeFileHeader(filename);
writeTagList(tags);
}
public static void writeClass(String filename, ClassInfo cl)
{
if (out == null) {
return;
}
writeFileHeader(filename);
writeTagList(cl.inlineTags());
// enum constants
for (FieldInfo f: cl.enumConstants()) {
write("ENUM: " + f.name() + "\n");
writeTagList(f.inlineTags());
}
// fields
for (FieldInfo f: cl.selfFields()) {
write("FIELD: " + f.name() + "\n");
writeTagList(f.inlineTags());
}
// constructors
for (MethodInfo m: cl.constructors()) {
write("CONSTRUCTOR: " + m.name() + "\n");
writeTagList(m.inlineTags().tags());
}
// methods
for (MethodInfo m: cl.selfMethods()) {
write("METHOD: " + m.name() + "\n");
writeTagList(m.inlineTags().tags());
}
}
}
|
