In its simplest form, dydoc can be invoked with just one parameter:
java -jar dydoc file:///Path/To/jar.jar
The parameter is an URL pointing to the jar file to be documented.
classpath
dydoc uses the runtime information provided by the JVM to generate the classes documentation. You will therefore need to set the appropriate java classpath as necessary.
configuration
dydoc uses a PL file for additional configuration parameters.
You can point dydoc to its configuration file by passing an URL parameter to it:
java -jar dydoc file:///Path/To/dydoc.plist
The configuration map supports the following key-value pairs:
"jar.dirs" = ( "file:///Path/To/jar.jar" );
jar.dirs takes a collection of URLs pointing to the jar files to be documented.
"src.dirs" = ( "file:///Path/To/Source/" );
src.dirs takes a collection of URLs pointing to the source file directories of the jar files to be documented. If a source file can be found for a given class, its javadoc comments are extracted and included in the corresponding class dydoc.
"doc.dir" = "file:///Path/To/Doc/";
doc.dir takes an URL pointing to the directory where to create the dydoc itself. If not specified, doc.dir defaults to the current directory.
"stub.dir" = "file:///Path/To/Stub/";
stub.dir takes an URL pointing to the directory where to create the dydoc stubs. If not specified, stub.dir defaults to the current directory.
"dependencies" = "true";
dependencies takes a string value of either true or false. If not specified, dependencies defaults to false. If true, all the classes dependencies are included in the dydoc.
* * *