The Domino Javadoc Generator generates documentation for the Lotus Notes API for Java. Its primary goal is to create a comprehensive reference guide.
The Domino Javadoc Generator project is an effort to create a comprehensive documentation of the Lotus Notes API for Java in a standardized format recognized by the Java community and accepted by most IDEs for Java. Typically, the Lotus Notes API is distributed as a Java archive and subjected to native format documentation through a Domino database with the IBM Domino Designer. This documentation can only be viewed in the Lotus Notes environment and cannot be used for Java class description, browse classes or methods, or provide automatic code insertion based on a Java object and its class.
The objective of this project is to generate a Javadoc documentation along with a pseudo-source code for the Lotus Notes API, allowing it to be viewed, indexed, and integrated into IDEs. The pseudo-source code can be integrated into IDEs to support object browsing and automatic source code insertion.
To use this application, you will need to have Lotus Notes and Domino Designer (tested version 7.0.1), JDK (tested version 1.5.0), Apache Ant (tested version 1.6.5), and EXSLT processor (tested version xsltproc gnu-xml with libxml-20615, libxslt-10112, and libexslt-810) installed.
You can install the package by creating a directory and then unpacking the bin package into that directory. You will then need to adjust the path to your local Java SDK installation, Lotus Notes directory, and paths to other tools in the example batch file before running it. Once you have set the required parameters, you can produce the documentation by running the script.
The generated files are provided in a convenient downloadable archive called domino-javadoc-0.3-out.zip. The latest release includes several improvements such as better handling of command-line parameters, support for additional documentation pages and sections, and templates for output conversion of tables. It also includes links to classes, methods, examples, and other related pages, making it easy to use and navigate.
Overall, the Domino Javadoc Generator project is a useful tool for developers working with Lotus Notes API for Java. It simplifies the documentation process and enables the use of various Java tools to display descriptions of Java classes and other related functionalities.
The objective of this project is to generate a Javadoc documentation along with a pseudo-source code for the Lotus Notes API, allowing it to be viewed, indexed, and integrated into IDEs. The pseudo-source code can be integrated into IDEs to support object browsing and automatic source code insertion.
To use this application, you will need to have Lotus Notes and Domino Designer (tested version 7.0.1), JDK (tested version 1.5.0), Apache Ant (tested version 1.6.5), and EXSLT processor (tested version xsltproc gnu-xml with libxml-20615, libxslt-10112, and libexslt-810) installed.
You can install the package by creating a directory and then unpacking the bin package into that directory. You will then need to adjust the path to your local Java SDK installation, Lotus Notes directory, and paths to other tools in the example batch file before running it. Once you have set the required parameters, you can produce the documentation by running the script.
The generated files are provided in a convenient downloadable archive called domino-javadoc-0.3-out.zip. The latest release includes several improvements such as better handling of command-line parameters, support for additional documentation pages and sections, and templates for output conversion of tables. It also includes links to classes, methods, examples, and other related pages, making it easy to use and navigate.
Overall, the Domino Javadoc Generator project is a useful tool for developers working with Lotus Notes API for Java. It simplifies the documentation process and enables the use of various Java tools to display descriptions of Java classes and other related functionalities.
What's New
Version 0.4: N/A