On Mon, Aug 28, 2017 at 9:12 AM, Charles Wilt <charles.wilt@xxxxxxxxx> wrote:
Also wondering if one of the existing non-RPG tool is extendable enough to
use with RPG.
The answer depends largely on what you're expecting from the
documentation software and what conventions you're willing to adopt
within the RPG code to be documented.
The primary and most basic way these kinds of tools work is by reading
the comments and formatting them nicely as HTML (or other form
suitable for viewing or printing). As such, since RPG's comment
delimiters are compatible with those of C++ and Java, many tools for
those languages will work as-is with RPG to some extent, as long as
the content of your comments follows their requirements.
A greater level of automation can occur if the tool knows something
about how functions or procedures or classes or whatever are defined
in your language. I think some of the non-RPG tools *could* be
extended (through plugins or other additional programming) to
understand RPG definitions.
Did you already have any "existing non-RPG tools" in mind? What kind
of functionality are you interested in, and does it matter whether the
tool can be run on the i itself?
I don't use doc generation tools myself, but one project which I found
particularly interesting is Natural Docs:
http://www.naturaldocs.org/
John Y.
midrange.com
