FazBrowse GitHub Viewer
|
Trending
|
URL:
|
Home
Tools:
[Download Repo ZIP]
[View Raw Code]
[Original HTTPS Page]
JavaDoc/src/main/java/javadoc/api/JavaDocReader.java at master · afkT/JavaDoc · GitHub
afkT
/
JavaDoc
Public
Notifications
You must be signed in to change notification settings
Fork
8
Star
26
Code
Issues
0
Pull requests
0
Actions
Projects
Security and quality
0
Insights
Additional navigation options
Code
Issues
Pull requests
Actions
Projects
Security and quality
Insights
Expand file tree
Breadcrumbs
JavaDoc
/
src
/
main
/
java
/
javadoc
/
api
/
JavaDocReader.java
Copy path
More file actions
More file actions
Latest commit
History
History
History
158 lines (141 loc) · 4 KB
Breadcrumbs
JavaDoc
/
src
/
main
/
java
/
javadoc
/
api
/
JavaDocReader.java
Copy path
File metadata and controls
158 lines (141 loc) · 4 KB
Raw
Copy raw file
Download raw file
Open symbols panel
Edit and raw actions
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
package
javadoc
.
api
;
import
com
.
sun
.
javadoc
.
ClassDoc
;
import
com
.
sun
.
javadoc
.
RootDoc
;
/**
* detail: JavaDoc 读取类
* @author Ttt
*/
public
final
class
JavaDocReader
{
private
JavaDocReader
() {
}
// Doc 信息临时存储
private
static
RootDoc
mRoot
;
/**
* detail: 一个简单 Doclet, 收到 RootDoc 对象保存起来供后续使用
* @author Ttt
*/
public
static
class
Doclet
{
public
Doclet
() {
}
/**
* Doclet 中, 方法 start 必须为静态
* @param root {@link RootDoc}
* @return true
*/
public
static
boolean
start
(
final
RootDoc
root
) {
mRoot
=
root
;
return
true
;
}
}
// =============
// = 回调通知接口 =
// =============
/**
* detail: 读取回调
* @author Ttt
*/
public
interface
Callback
{
/**
* 回调通知
* @param path 文件路径
* @param className 文件名 ( 类名 )
* @param rootDoc 根 Doc 信息
* @param classDocs 类 Doc 信息
* @return 处理后的文档信息
*/
String
callback
(
String
path
,
String
className
,
RootDoc
rootDoc
,
ClassDoc
[]
classDocs
);
/**
* 异常回调
* @param e 异常信息
*/
void
error
(
Exception
e
);
}
// ==========
// = 读取处理 =
// ==========
/**
* 读取处理
* @param callback 读取回调
* @param path 文件路径
* @param className 文件名 ( 类名 )
* @return 处理后的文档信息
*/
private
static
String
read
(
final
Callback
callback
,
final
String
path
,
final
String
className
) {
// 类 Doc 信息
ClassDoc
[]
classDocs
=
null
;
// 如果有内部类, 则长度大于 1, 否则为 1 ( 指定的 className)
// 防止为 null
if
(
mRoot
!=
null
) {
classDocs
=
mRoot
.
classes
();
}
// 触发回调
if
(
callback
!=
null
) {
return
callback
.
callback
(
path
,
className
,
mRoot
,
classDocs
);
}
return
null
;
}
// =============
// = 对外提供方法 =
// =============
/**
* 读取文档处理
* @param callback 读取回调
* @param path 文件路径
* @param className 文件名 ( 类名 )
* @param executeParams 执行参数
* @return 处理后的文档信息
*/
public
static
String
readDoc
(
final
Callback
callback
,
final
String
path
,
final
String
className
,
final
String
[]
executeParams
) {
try
{
// 调用 com.sun.tools.javadoc.Main 执行 javadoc, 具体参数百度搜索
com
.
sun
.
tools
.
javadoc
.
Main
.
execute
(
executeParams
);
// 进行读取
return
read
(
callback
,
path
,
className
);
}
catch
(
Exception
e
) {
if
(
callback
!=
null
) {
callback
.
error
(
e
);
}
}
return
null
;
}
// =
/**
* 创建执行参数
* <pre>
* 根据自己的需求创建, 对应需要的执行参数
* 该方法, 主要是示范, 并且自用
* </pre>
* @param readAll 是否读取全部 (-private 显示所有类和成员 )
* @param path 文件路径
* @param className 文件名 ( 类名 )
* @return 执行参数
*/
public
static
String
[]
getExecuteParams
(
final
boolean
readAll
,
final
String
path
,
final
String
className
) {
if
(
readAll
) {
return
new
String
[]{
"-private"
,
"-encoding"
,
"utf-8"
,
"-doclet"
,
Doclet
.
class
.
getName
(),
path
+
className
};
}
else
{
return
new
String
[]{
"-encoding"
,
"utf-8"
,
"-doclet"
,
Doclet
.
class
.
getName
(),
path
+
className
};
}
}
}
Back
|
FazBrowse Home
|
New Git URL