 |
|
|
|
|
|
As a member of this group space, your screen name will appear in the members list, you'll have access to the space's message board (if applicable), and you may receive e-mails pertinent to the space.
Before applying for membership to this space, please make sure you're logged in to developerWorks.
Log in or register now.
We'll be in touch after we've reviewed your request. Thanks for your interest in developerWorks spaces!
|
|
|
|
|
|
|
|
|
Part 1: Eclipse Javadoc API reference structure generated using JavaTOC doclet
|
|
|
This article describes different approaches for generating easy-to-use and searchable Java application programming interfaces (API) references documentation. The approaches described are the Javadoc standard solution and the Eclipse Plug-in Help System generated using the JavaTOC doclet that I developed. The JavaTOC doclet creates a table-of-contents (TOC) for the Javadoc API reference documentation helping the user to easily search the API reference documentation for a specific class, interface or method.
|
|
|
Part 2: Eclipse Javadoc API reference structure generated using the JavaTOC docl
|
|
|
This article discusses the JavaTOC doclet tool, how to use it and how to extend it. The approach uses the Javadoc standard solution and the Eclipse Plug-in Help System generated using the JavaTOC doclet that I developed. The JavaTOC doclet tool generates the necessary XML table-of-contents (TOC) navigation files for the Eclipse Help system, and the Sun Javadoc API reference documentation in HTML format. To understand the approach, I included a demo example that uses the Sun Javadoc and the JavaTOC doclet tool (using Command Prompt).
|
|
|
Part 3: Eclipse Javadoc API reference structure generated running the JavaTOC do
|
|
|
This article further discusses the JavaTOC doclet, how to use it, and how to extend it. The approaches described are the Javadoc standard solution and the Eclipse Plug-in Help System generated using the tool. I will run the JavaTOC doclet in Eclipse through the Custom doclet wizard, and second through Ant build system. The JavaTOC tool generates the TOC XML navigation for Java API reference documentation.
|
|
|
Creating Javadoc API documentation with directly updated source
|
|
|
The article describes the generation of Javadoc documentation using a directly updated source code in IBM Rational® ClearCase® (hereafter, ClearCase). The process described in this article is the result of discussions and experimentation by development and documentation teams. The proposed API reference documentation process streamlines the process for generating public API Javadoc documentation for applications. The process resolves the need to copy source code files back and forth between developers and the API writer. It also ensures that the latest source code is always being used and updated. As a result, the generated Javadoc HTML files will reflect both writer input and developer comments with minimal developer effort to merge in the API writer edits. Also, the Javadoc builds for internal customers will include the most complete documentation possible, because all documentation updates are reflected back into the source code.
|
|
|
DITA DOCLET TOOL AND METHOD FOR EXTRACTING AND ANALYZING API DOC
|
|
|
The DITAdoclet testing tool extracts the developer comments from the Java source code; migrates the information to DITA API files (topic types) and provides the technical writers with the information necessary to identify what documentation or tagging is missing from the Java source code, and indirectly from the API reference documentation. It provides technical writers (Information Developers) with a visual identification of the missing tagging and descriptions for classes, interfaces, methods, parameters, etc.
|
|
|
|
Show member list
