The Document Extractor allows you to take comments out of
your MACRO-11, FORTRAN or Z80 programs and put them into a
separate file. With this tool, it then becomes practical to
embed the program's documentation within the program itself.
This has two distinct benefits: one, it keeps a program's
documentation close to the program that it describes, and
two, it allows for later extraction into a separate document
that can be included as part of the program's formal docu-
mentation. Thus, as a program changes, the documentation
for it can also change right in the program itself. This
means that you stand a far better chance of having the pro-
gram documentation updated than if the source code and docu-
mentation are in two separate file.
There isn't any RUNOFF file to describe the Document Extrac-
tor. In its place, the source code for the Documentation
Extractor itself contains all the documentation for the Do-
cumentation Extractor. However, you do not have to read the
source code in order to find out how the Documentation Ex-
tractor works. Instead, the procedure outlined below will
assembly, task build and extract the necessary comments from
the Documentation Extractor's source code.
In order to get the Documentation Extractor running on your
system, you should issue the following command:
>@DOC
This command file will assembly the Documentation Extractor,
task build both it and the cross-reference utility and fi-
nally extract the comments from the Documentation
Extractor's source code into the DOC.DOC file. You should
then read this file to find out how to use the Documentation
Extractor.
Submitted by: Mike Drabicky
Rockwell International
1200 N Alma Way MS 406-280
Richardson, TX 75081
(204) 996-5353