Browse Prior Art Database

JavaDocMerge tool for separating JavaDoc Information from Java Source

IP.com Disclosure Number: IPCOM000016105D
Original Publication Date: 2002-Sep-23
Included in the Prior Art Database: 2003-Jun-21
Document File: 2 page(s) / 41K

Publishing Venue

IBM

Abstract

Disclosed is a program that describes a method and system, embodied as a development tool called JavaDocMerge, that supports the separation of documentation information in the form of JavaDoc into a separate source file. Previously, there was a problem with having a good way to edit and translate programming level information expressed in JavaDoc tags within Java* source code. Additionally, when Java software is generated from IDL, or other means, no documentation is generated. In order to enable documentation to be derived from other formats and then generated (or merged) with the output of the IDL compiler, a tool is needed. To complicate matters, there are several compiler tools similar to IDLJ that generate different types of bindings from the interface defined in the IDL. Additionally, JavaDoc information is typically not edited by an editorial staff, but rather, only authored by the software developers. This does not produce optimal level of quality for the JavaDoc documentation generated from the source code. The JavaDocMerge tool enables documentation information to be stored separate from the Java source code. The JavaDocMerge tool processes a source file that has tagged documentary information for Java source code, and then processes the source code, to locate the appropriate place to integrate the information. The JavaDocMerge tool is able to account for generated binding differences, such as output parameters verses return parameters, and correctly apply the documentation information. The JavaDocMerge tool is a command-line driven tool that can easily be called from an automated build, particularly from ANT which is a popular Java build tool.

This text was extracted from a PDF file.
This is the abbreviated version, containing approximately 53% of the total text.

Page 1 of 2

JavaDocMerge tool for separating JavaDoc Information from Java Source

Disclosed is a program that describes a method and system, embodied as a development tool called JavaDocMerge, that supports the separation of documentation information in the form of JavaDoc into a separate source file.

Previously, there was a problem with having a good way to edit and translate programming level information expressed in JavaDoc tags within Java* source code. Additionally, when Java software is generated from IDL, or other means, no documentation is generated. In order to enable documentation to be derived from other formats and then generated (or merged) with the output of the IDL compiler, a tool is needed. To complicate matters, there are several compiler tools similar to IDLJ that generate different types of bindings from the interface defined in the IDL. Additionally, JavaDoc information is typically not edited by an editorial staff, but rather, only authored by the software developers. This does not produce optimal level of quality for the JavaDoc documentation generated from the source code.

The JavaDocMerge tool enables documentation information to be stored separate from the Java source code. The JavaDocMerge tool processes a source file that has tagged documentary information for Java source code, and then processes the source code, to locate the appropriate place to integrate the information. The JavaDocMerge tool is able to account for generated binding differences, such as output parameters verses return parameters, and correctly apply the documentation information.

The JavaDocMerge tool is a command-line driven tool that can easily be called from an automated build, particularly from ANT which is a popular Java build tool.

JavaDocMerge [-I incPath] -src tagfile -dest destDir [-idl idlFile | -java javadir]

[-log] [-convertreturnparam] [-packageroot package] [-helpers]

JavaDocMerge reads the tagfile (included from incPath) and java or idl files,

and merges JavaDoc tags into the files in the destination directory.

tagfile contains source material in the following format:

@@include filename

@@package packageName description

@@class className description

@@method methodName description

@@field fieldname description @@param parmName description @@throws exceptionClass description @@return description @@image fil...