|
| |||
|
|
|
|||
|
developerWorks
>
My developerWorks
>
Spaces
>
|
|
|
|
DITA Java API tools and solutions |
|
|
|
|
||||||
|
||||||||||||||||
|
|
| 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. |
|
| 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. |
|
| 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. |
|
| 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. 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. |
|
|
 |
|
|
|||||||||||||||||||||
|
|
|||||||||||||||||||||
|
|||||||||||||||||||||
|
|||||||||||||||||||||
|
|||||||||||||||||||||
Show member list
