KtsDoclet is an alternative to the Standard Doclet provided with the JDK^TM. KtsDoclet supports all options supported by the Standard Doclet and generates documentation with the same overall format and organization. There are, however, differences between KtsDoclet and the Standard Doclet in performance and the exact format of the generated documentation. KtsDoclet also provides some additional functionality.

Current version of KtsDoclet is 1.0.0, released on March 27, 2008.

KtsDoclet is a commercial royalty-free software. In other words, you can download and use KtsDoclet free of charge, but you cannot reverse engineer, modify or redistribute it. You must read and accept the End User License Agreement before downloading and using KtsDoclet.

By downloading KtsDoclet, you agree to the End User License Agreement.

 

Installation instructions: KtsDoclet is distributed as a WinZip file. It does not require any special installation and can be used, after unpacking, on any platform. It is, basically, a single JAR file and the documentation file. Unpack downloaded ZIP file in any empty directory and read the readme file and/or the documentation.

 

What is KtsDoclet?

KtsDoclet is a complete Doclet able to generate Javadoc^TM documentation when used with the Javadoc tool. Documentation generated by KtsDoclet uses very similar, but not identical, organization and format as the documentation generated by the Standard Doclet. KtsDoclet supports all options supported by the Standard Doclet, with the only exception of option -footer (KtsDoclet documentation has an explanation why -footer is not supported). KtsDoclet supports all language features including all features of Java 1.5 such as generics and annotation types. The documentation pages generated by KtsDoclet are heavily based on CSS. Custom CSS is supported such that you can modify default CSS to change colors and/or fonts of virtually any element in the documentation pages. It is also possible that in the future KtsDoclet will provide different CSS files such that you will be able to choose among several documentation styles. It can be also noted that internally KtsDoclet uses templates in order to generate output HTML pages. While at this time templates are used only as a matter of internal implementation, it enables KtsDoclet to be easily modified to implement new features, documentation format changes, and similar.

 

Why use KtsDoclet?

You should find KtsDoclet to be significantly faster than the current version of the Standard Doclet (performance difference may be minimal when building the documentation from relatively small set of Java source files). KtsDoclet also offers additional features as well as the documentation generated by KtsDoclet has improved format. It is very easy to try KtsDoclet (read the documentation for instructions) simply adding -doclet and optionally -docletpath into your existing script. We advise you to try it and see if you like KtsDoclet performance and the output. If you do, you can read the documentation to learn about additional features offered by KtsDoclet.

 

What are System Requirements, Java version?

KtsDoclet is a 100% pure Java^TM program. It has been tested with JDK 1.5 - JDK 1.7 (Beta). It can be used with any JVM^TM compatible with Sun's JVM version 1.5 or greater. It will generate documentation for source code prior to 1.5, however, it should be run by JVM 1.5 or greater. KtsDoclet may use slightly more memory than the Standard Doclet, however, normally only 10%-15% more which does not represent a practical problem. KtsDoclet documentation provides detailed description of memory consumption by the Javadoc tool and KtsDoclet.

 

Is KtsDoclet open source software?

No, KtsDoclet is not open source software. It is a commercial royalty-free software. You can use it free of charge to generate the documentation, including generating the documentation for commercial systems manufactured by you or your company.
You are not allowed to reverse engineer or modify KtsDoclet. You are also not allowed, by the License Agreement, to distribute KtsDoclet. You can, of course, refer anyone to this website where KtsDoclet can be obtained and used free of charge.

 

Is KtsDoclet supported?

Yes, disclaiming that support is voluntary on our part. The License Agreement provides no guarantees or promise of support. We, however, would like to know about any defects discovered in KtsDoclet and will correct defects when we can. We have tested KtsDoclet with numerous large Java systems and verified it with Internet Explorer, Firefox, Opera and Safari browsers.
If you encounter issues or have a question, please follow the guidelines listed on the support page in order to submit support request.

 

In case Java^TM Language specifications change in the future and the Doclet API is extended, we will very likely update KtsDoclet to support the latest Doclet API.

 

Can I send a request for a new feature?

Yes, we would like to hear what new features users want to have. We do not give any guarantees what features, if any, will be added or when they may be added into KtsDoclet. However, it is possible that frequently requested features approved by our developers will be added into some future version of KtsDoclet.

 

Java, JVM, JDK and Javadoc are trademarks or registered trademarks of Sun Microsystems, Inc. in the United States and other countries.