Echo Web Framework

To run CoreDoc, you'll need a current version of CoreJS (available from the download page) and a recent version of Java (1.4 or later).

CoreDoc is executed by running a JAR file and specifying the path to a CoreDoc XML documentation descriptor file that specifies what files are to be documented:

java -jar CoreDoc.jar /path/to/your/descriptor/file/doc.xml

Creating descriptor files is discussed in the next section. CoreDoc is packaged with example documentation descriptors that will document Core.JS' JavaScript libraries and the Echo3 client-side framework.