Re: javadoc for RPGLE

I all depends on what you are going to use the documentation for.

In my case I would never make documentation that wasn't so good that I as
the developer
can't use and find value in it myself and that means ...

- a general desciption of the module/service program
-- a list of the methods/procedures
--- a description of each method/procedure with i/o parameters
---- a direct access to the actual code so I havn't have to go anywhere
else to look up either the code or the details of the interface (field
types and lenghts)

When that is said it is actually a hell to make that kind of documentation
afterwards :-(

On Tue, Aug 29, 2017 at 11:05 PM, John Yeung <gallium.arsenide@xxxxxxxxx>
wrote:

On Tue, Aug 29, 2017 at 4:34 PM, Jon Paris <jon.paris@xxxxxxxxxxxxxx>
wrote:

The major difference with Paul's is that the heart of the tool is a scan

and store engine that places all the information in a database. The
presentation layers he provides (one in CGIDEV2 and one in PHP) are simply
demonstrations of what can be done to customize the output. i.e. there is
no fixed output (other than the database) you can do what you want. This
means that if all you want to do is run queries over the data with SQL you
can do so at any time.

It occurs to me as I write this, that one could simply generate

"Javascript" ( or "C++" or whatever ) from Paul's database and then run
whatever documentation tool-du-jour you happen to prefer from the available
OS offerings.

If you mean generate actual JavaScript code or actual C++ code, I
don't think it's as simple as you make it sound. However, the database
would indeed be super-handy and flexible, and very adaptable to
various presentation layers.

From what I can gather, this is pretty close to the best-case scenario
for using Sphinx with RPG. But of course I'd check out Paul's included
presentation layers first, as those would be easiest of all.

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