|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object de.smartics.analysis.javadoc.JavadocUtils
public final class JavadocUtils
Utilities to communicate with the Javadoc tool.
Field Summary | |
---|---|
static String |
PARAM_NAME_PACKAGENAMES The name of the parameter to pass the list of package names as arguments to the Javadoc tool. |
static String |
PARAM_NAME_SOURCEFILES The name of the parameter to pass the list of source files as arguments to the Javadoc tool. |
Method Summary | |
---|---|
static Console |
executeJavadocParser(String programName, Map<String,String> javadocArguments) Runs the Javadoc tool. |
static Console |
executeJavadocParser(String programName, String[] args) Runs the Javadoc tool. |
static int |
executeJavadocParser(String programName, String defaultDocletClassName, Map<String,String> javadocArguments, JavadocMessageLogger logger) Runs the Javadoc tool. |
static String[] |
generateJavadocParserArguments(Map<String,String> javadocArguments) Flattens the arguments found in the properties to an array to be passed to the Javadoc tool. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String PARAM_NAME_SOURCEFILES
The value of this constant is "sourcefiles".
"sourcefiles"
public static final String PARAM_NAME_PACKAGENAMES
The value of this constant is "packagenames".
"packagenames"
Method Detail |
---|
public static Console executeJavadocParser(String programName, Map<String,String> javadocArguments)
generateJavadocParserArguments(Map)
and
executeJavadocParser(String, String[])
.
programName
- the name of the program that runs the Javadoc collector. This string will be passed to the Javadoc tool and is used for logging purpose.
javadocArguments
- the arguments to pass to the Javadoc tool. The properties are not validated and any property found here is set as an argument to the Javadoc tool. The property names usually start with a dash. If not, the value may be adjusted to meet certain criteria and the dash will be added prior to passing it to the Javadoc tool.
public static Console executeJavadocParser(String programName, String[] args)
programName
- the name of the program that runs the Javadoc collector. This string will be passed to the Javadoc tool and is used for logging purpose.
args
- the arguments to the Javadoc too.
executeJavadocParser(String, Map)
public static int executeJavadocParser(String programName, String defaultDocletClassName, Map<String,String> javadocArguments, JavadocMessageLogger logger)
programName
- the name of the program that runs the Javadoc collector. This string will be passed to the Javadoc tool and is used for logging purpose.
defaultDocletClassName
- the doclet to run.
javadocArguments
- the arguments to pass to the Javadoc tool. The properties are not validated and any property found here is set as an argument to the Javadoc tool. The property names usually start with a dash. If not, the value may be adjusted to meet certain criteria and the dash will be added prior to passing it to the Javadoc tool.
logger
- the logger to print error, warn and notice messages to.
public static String[] generateJavadocParserArguments(Map<String,String> javadocArguments)
javadocArguments
- the arguments to pass to the Javadoc tool. The properties are not validated and any property found here is set as an argument to the Javadoc tool. The property names usually start with a dash. If not, the value may be adjusted to meet certain criteria and the dash will be added prior to passing it to the Javadoc tool.
javadocArguments
as array.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |