API documentation process series, Creating Javadoc API documentation with directly updated source

From the developerWorks archives

Mariana Alupului and Don Weinand

Date archived: December 19, 2016 | First published: May 09, 2006

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.

This content is no longer being updated or maintained. The full article is provided "as is" in a PDF file. Given the rapid evolution of technology, some steps and illustrations may have changed.



static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=Java development, Rational
ArticleID=110481
ArticleTitle=API documentation process series: Creating Javadoc API documentation with directly updated source
publish-date=05092006