15
15
16
16
/**
17
17
* Execute the javadoc command line tool to process source code files.
18
+ *
18
19
* @author Manoel Campos
19
20
*/
20
21
public class JavaDocCLI {
@@ -40,27 +41,27 @@ public class JavaDocCLI {
40
41
41
42
/**
42
43
*
43
- * @param extendedClassPath Any classpath information required to help along javadoc. Javadoc
44
- * will actually compile the source code you specify; so if there are any jars or classes
45
- * that are referenced by the source code to process, then including those compiled items
46
- * in the classpath will give you more complete data in the resulting XML.
47
- * @param sourcePaths Usually sourcePaths is specified in conjunction with either/both packages &
48
- * subpackages. The sourcepaths value should be the path of the source files right before
49
- * the standard package-based folder layout of projects begins. For example, if you have
50
- * code that exists in package foo.bar, and your code is physically in /MyFolder/foo/bar/,
51
- * then the sourcePaths would be /MyFolder
52
- * @param packages Use if you want to detail specific packages to process (contrast with
53
- * subpackages, which is probably the easiest/most brute force way of using xml-doclet).
54
- * If you have within your code two packages, foo.bar and bar.foo, but only wanted
55
- * foo.bar processed, then specify just 'foo.bar' for this argument.
56
- * @param sourceFiles You can specify source files individually. This usually is used instead of
57
- * sourcePaths/subPackages/packages. If you use this parameter, specify the full path of
58
- * any java file you want processed.
59
- * @param subPackages You can specify 'subPackages', which simply gives one an easy way to
60
- * specify the root package, and have javadoc recursively look through everything under
61
- * that package. So for instance, if you had foo.bar, foo.bar.bar, and bar.foo,
62
- * specifying 'foo' will process foo.bar and foo.bar.bar packages, but not bar.foo
63
- * (unless you specify 'bar' as a subpackage, too)
44
+ * @param extendedClassPath Any classpath information required to help along javadoc. Javadoc
45
+ * will actually compile the source code you specify; so if there are any jars or classes
46
+ * that are referenced by the source code to process, then including those compiled items
47
+ * in the classpath will give you more complete data in the resulting XML.
48
+ * @param sourcePaths Usually sourcePaths is specified in conjunction with either/both packages &
49
+ * subpackages. The sourcepaths value should be the path of the source files right before
50
+ * the standard package-based folder layout of projects begins. For example, if you have
51
+ * code that exists in package foo.bar, and your code is physically in /MyFolder/foo/bar/,
52
+ * then the sourcePaths would be /MyFolder
53
+ * @param packages Use if you want to detail specific packages to process (contrast with
54
+ * subpackages, which is probably the easiest/most brute force way of using xml-doclet).
55
+ * If you have within your code two packages, foo.bar and bar.foo, but only wanted
56
+ * foo.bar processed, then specify just 'foo.bar' for this argument.
57
+ * @param sourceFiles You can specify source files individually. This usually is used instead of
58
+ * sourcePaths/subPackages/packages. If you use this parameter, specify the full path of
59
+ * any java file you want processed.
60
+ * @param subPackages You can specify 'subPackages', which simply gives one an easy way to
61
+ * specify the root package, and have javadoc recursively look through everything under
62
+ * that package. So for instance, if you had foo.bar, foo.bar.bar, and bar.foo,
63
+ * specifying 'foo' will process foo.bar and foo.bar.bar packages, but not bar.foo
64
+ * (unless you specify 'bar' as a subpackage, too)
64
65
* @param additionalArguments Additional Arguments.
65
66
*/
66
67
private JavaDocCLI (
@@ -127,12 +128,14 @@ private DocumentationTool.DocumentationTask createTask(
127
128
128
129
/**
129
130
* Actually starts the javadoc CLI.
131
+ *
130
132
* @param task javadoc task to run
131
133
*/
132
134
private static void runJavaDocTask (final DocumentationTool .DocumentationTask task ) {
133
135
if (task .call ())
134
136
System .out .println ("Doclet ran successfully" );
135
- else System .err .println ("Doclet execution failed" );
137
+ else
138
+ System .err .println ("Doclet execution failed" );
136
139
}
137
140
138
141
/** Aggregate arguments (including package names). */
0 commit comments