Re: javadoc for RPGLE

John,

I saw mention of Natural Docs...but hadn't really looked at it as the post
I found about it mentioned it had been rewritten in C#.

Started out looking at Doxygen then got pointed to sphinx...which lead back
to Doxygen via Breathe :)


Charles


On Mon, Aug 28, 2017 at 10:29 AM, John Yeung <gallium.arsenide@xxxxxxxxx>
wrote:

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.
--
This is the RPG programming on the IBM i (AS/400 and iSeries) (RPG400-L)
mailing list
To post a message email: RPG400-L@xxxxxxxxxxxx
To subscribe, unsubscribe, or change list options,
visit: http://lists.midrange.com/mailman/listinfo/rpg400-l
or email: RPG400-L-request@xxxxxxxxxxxx
Before posting, please take a moment to review the archives
at http://archive.midrange.com/rpg400-l.

Please contact support@xxxxxxxxxxxx for any subscription related
questions.

Help support midrange.com by shopping at amazon.com with our affiliate
link: http://amzn.to/2dEadiD