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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
extern crate clap;
extern crate regex;
extern crate threadpool;
mod model;
mod parse;
use clap::App;
use clap::Arg;
use std::fs;
use std::fs::File;
use std::io::prelude::*;
use std::path::Path;
use std::path::PathBuf;
use std::sync::Arc;
use threadpool::ThreadPool;
use model::model::Class;
use model::model::LineType;
use parse::parse::parse_file;
fn is_java_file(file: &str) -> bool {
let line_vec: Vec<&str> = file.split(".").collect::<Vec<&str>>();
let l_index = line_vec.len() - 1;
if line_vec[l_index].contains("java") {
true
} else {
false
}
}
pub fn find_java_files(start_dir: &Path) -> Vec<PathBuf> {
let mut files: Vec<PathBuf> = Vec::new();
let file_dir = fs::read_dir(start_dir);
if !file_dir.is_ok() {
return files.clone();
}
for f in file_dir.unwrap() {
let p = f.unwrap().path();
if p.is_dir() {
let path = p.as_path();
let new_files = find_java_files(path);
for n_file in new_files {
files.push(n_file.clone());
}
} else if p.is_file() {
if is_java_file(p.as_path().file_name().unwrap().to_str().unwrap()) {
files.push(p.clone());
}
}
}
files.clone()
}
pub fn generate_markdown(class: Class, dest: &str) {
let name = format!("{}/{}.{}", dest, class.class_name, "md");
let mut file = File::create(name).unwrap();
let mut doc = format!("# {}\n\n", class.class_name);
if class.description.as_str() != "" {
doc.push_str(format!("description: {} \n", class.description.trim()).as_str());
}
doc.push_str(format!("privacy: {} \n", class.access.trim()).as_str());
doc.push_str(format!("package: {} \n\n", class.package_name.trim()).as_str());
if !class.exception.is_empty() {
doc.push_str(
format!(
"Throws {}: {} \n\n",
class.exception.exception_type, class.exception.desc
).as_str(),
);
}
doc.push_str("## Dependencies\n\n");
doc.push_str("<details> \n");
doc.push_str(" <summary> \n");
doc.push_str(" Show dependencies \n");
doc.push_str(" </summary> \n");
doc.push_str(" <ul> \n");
for dep in class.dependencies {
doc.push_str(format!("<li>{}</li>\n", dep).as_str());
}
doc.push_str(" </ul> \n");
doc.push_str("</details> \n\n");
doc.push_str("## Methods\n\n");
for member in class.methods {
doc.push_str(format!("### {}\n\n", member.name).as_str());
doc.push_str(format!("privacy: {} \n", member.privacy.trim()).as_str());
doc.push_str(format!("description: {} \n", member.description).as_str());
if !member.exception.is_empty() {
doc.push_str(
format!(
"Throws {}: {} \n",
member.exception.exception_type, member.exception.desc
).as_str(),
);
}
doc.push_str(format!("return: {} \n\n", member.return_type).as_str());
if member.parameters.len() > 0 {
doc.push_str("| Name | Type | Description | \n");
doc.push_str("| ----- | ----- | ----- | \n");
} else {
doc.push_str("This method has no parameters. \n");
}
for param in member.parameters {
doc.push_str(
format!(
"| {} | {} | {} | \n",
param.name, param.var_type, param.desc
).as_str(),
);
}
doc.push_str("\n\n");
}
file.write(doc.as_str().as_bytes())
.expect("Not able to write to file");
println!("{}.{} was created", class.class_name, "md");
}
pub fn document(file_paths: Vec<PathBuf>, dest: String) {
let files = Arc::new(file_paths);
let size = files.len();
let mut pool_size = size / 4;
if files.len() % 4 != 0 {
pool_size += 1;
}
let pool = ThreadPool::new(pool_size);
let safe_dest = Arc::new(dest);
for i in 0..pool_size {
let file_cp = files.clone();
let new_dest = safe_dest.clone();
pool.execute(move || {
for j in 0..3 {
if (i * 4) + j < size {
let class = parse_file(&file_cp[(i * 4) + j]);
generate_markdown(class, new_dest.as_str());
}
}
});
}
pool.join();
}
fn main() {
let matches = App::new("Javadoc-To-Markdown")
.version("1.0")
.author("Josh Brudnak <jobrud314@gmail.com>")
.about("A tool for generating markdown documentation from javadocs")
.arg(
Arg::with_name("INPUT")
.value_name("FILE")
.required(true)
.help("Sets the input directory to use")
.index(1),
)
.arg(
Arg::with_name("context")
.help("Sets the context path of the project")
.short("c"),
)
.arg(
Arg::with_name("verbose")
.short("v")
.help("Generate verbose documentation for a project"),
)
.arg(
Arg::with_name("destination")
.required(false)
.value_name("FILE")
.short("d")
.help("Sets the destination directory of the created markdown files"),
)
.get_matches();
let dir = matches
.value_of("INPUT")
.expect("Documentation directory not chosen")
.to_string();
let dest = matches
.value_of("destination")
.unwrap_or("./generated/")
.to_string();
fs::create_dir_all(dest.as_str()).expect("File path not able to be created");
println!("Generating documentation from {}", dir);
let file_paths = find_java_files(Path::new(dir.clone().as_str()));
if file_paths.len() > 0 {
document(file_paths, dest);
} else {
println!("No java files found");
}
}