nrxdoc - NetRexx Documentation Generator


	nrxdoc nrxdoc is a documentation generator for NetRexx like javadoc for Java. It generates API documentation in HTML format, for an individual NetRexx source file, or for all NetRexx files in a directory tree.



		0.91


	Synopsis


	`java com.ibm.de.pheuch.nrxdoc.nrxdoc [-r][-nopackage] [-noindex] docdir {directory \| NetRexx file}...`


	Parameters

-r	searches subdirectories when directories are specified
-noindex	do not generate a package index HTML file
-nopackage	do not generate a package, or package index HTML file
docdir	directory where the generated documentation HTML files are stored
directory	name of a directory where nrxdoc is searching for NetRexx (*.nrx) files. If the -r option is used all subdirectories are searched also.
NetRexx file	a NetRexx source file that is analysed by nrxdoc. The full name of the NetRexx file is needed.


	Batch programs

Batch programs for Windows and OS/2 are provided to simplify the usage of the nrxdoc program.

The OS/2 batch program NRXDOC.CMD must be in the same directory as the nrxdoc.zip file. No more settings are requiered.

The Windows batch program NRXDOC.BAT need an environment variable set:

SET NRXDOC=C:\NRXDOC\NRXDOC.ZIP

If the CLASSPATH includes the NRXDOC.ZIP file, the environment variable is not needed.

Comment Syntax

nrxdoc uses special comments (doc comments) that are included in the generated file. A doc comment starts with a /** and ends with at the next */. Nested comments are not allowed in a doc comment. A doc comment may include any HTML markup tags and special nexdoc tags.

The doc comments must be positioned before class, method or property variable definitions. Doc comments at any other place are ignored

A single line comment on the same line as a property variable definition is used as a doc comment also.

Special tags in the doc comments are used by nrxdoc:

@author text	This tag adds an "Author:" entry containing the specified text to the documentation. This tag should be used in a doc comment before a class definition
@param parameter	This tag adds the specified parameter and its description to the "Parameters:" section of the current method.
@return description	This tag adds a "Return:" section to the current method.
@exception full-classname description	Adds a "Signals" entry to the documentation. The entry contains the specified class name of the exception and the description specified. It may only be used before a method definition.

Generated files

Files created by nrxdoc:

PackageIndex.HTML	Contains references for all package description files.
Pkg-packagename.HTML	Package description file. Contains reference for all with nrxdoc documented NetRexx files of the package packagename.
fullqualifiedclassname.HTML	Class description file

Requests and suggestions?

Your comments, questions, and suggestions for nrxdoc and these Web pages are welcome! Send mail to me (Peter Heuchert) directly, using mail to pheuch@de.ibm.com .

This page was created on 17 Nov, 1997 it can be found from http://stey2.ncs.mainz.ibm.com