The util requires the following four parameters in the exact order:
- Path the root of the jsdoc-toolkit folder (e.g. /Users/lerlop/resources/Java/jsdoc-toolkit/2.0.2)
- Path the jsdoc template folder you’d like to use (e.g. /Users/lerlop/resources/Java/jsdoc-toolkit/2.0.2/templates/jsdoc)
- Path to the XDP file
- Path to the output directory
<?xml version="1.0" encoding="UTF-8"?>
<project name="test-ant" basedir=".">
java -jar xdp-jsdoc-gen.jar /Users/lerlop/resources/Java/jsdoc-toolkit/2.0.2 /Users/lerlop/resources/Java/jsdoc-toolkit/2.0.2/templates/jsdoc ../test.xdp /Users/lerlop/Desktop/output
----- Being processing ----- Finished writing /Users/lerlop/Desktop/output/SO.js Finished writing /Users/lerlop/Desktop/output/ArraySO.js Finished writing /Users/lerlop/Desktop/output/StringSO.js Generating jsdoc at /Users/lerlop/Desktop/output/jsdocs JSDocs created successfully in /Users/lerlop/Desktop/output/jsdocs ----- End -----
// Instantiate a generator object JSDocGenerator generator = new JSDocGenerator(jsdocToolkitPath,templatePath, xdpPath, outputPath); // run generator.run();
The generated files should look similar to this.
And the documentation itself should look similar to this.
As a note, the input form design needs to be in an XDP format. So if your form is in PDF, you need to save it as XDP in LiveCycle Designer or programmatically call LiveCycle Forms to convert PDF to XDP. Moreover, if you have a lot of forms in a LiveCycle repository (e.g. database or Documentum), you can write a Java application that loops through the forms in the repository using the LiveCycle repository API.