× The internal search function is temporarily non-functional. The current search engine is no longer viable and we are researching alternatives.
As a stop gap measure, we are using Google's custom search engine service.
If you know of an easy to use, open source, search engine ... please contact support@midrange.com.


  1.  Home
  2. RPG400-L
  3. August 2017

Re: javadoc for RPGLE

I use jsDoc

it is however a little tricky since jsDoc documents javascript so what I do
is that I
embed the subprocedures in javascript:

/*
* JSDOC @ instructions and HTML
*/
function subprocedure() { /**

RPGLE subprocedure code

*/ };

This generates the code for jsDOC where the RPGLE statements just are a
comment block

In order to compile the service program the javascript instruction
(function subprocedure) is
comment out in the source and there are minor changes to the JSDOC part so
it is treated as
RPGLE comments.

So I have a program that is able to change the compilable RPGLE service
program to
javascript syntax.

jsDoc then creates the base documentation and then i run a node.js program
that make
changes to the generated documentation such as inserting the IBM i logo and
headings.



On Mon, Aug 28, 2017 at 4:41 PM, Charles Wilt <charles.wilt@xxxxxxxxx>
wrote:

What are you using to parse/generate the docs?

Charles

On Mon, Aug 28, 2017 at 8:17 AM, Henrik Rützou <hr@xxxxxxxxxxxx> wrote:

Well I have been working a little with mixing HTML and a Serviceprogram
to
make
inline documentation that ends up like this (it is a prototype)

http://www.powerext.com/zdocs/pxapicgi/pxApiCgi.html

On Mon, Aug 28, 2017 at 4:07 PM, Charles Wilt <charles.wilt@xxxxxxxxx>
wrote:

b) procedures in a service program...

Charles

On Mon, Aug 28, 2017 at 8:02 AM, Henrik Rützou <hr@xxxxxxxxxxxx>
wrote:

What are you trying to document and at what level.

a. Is it where fields are used and defined etc.?
b. Is it procedures in a service program like methods in a javscript
module
like this ...
http://powerext.com/zdocs/zInput/zInput.html



On Mon, Aug 28, 2017 at 3:12 PM, Charles Wilt <
charles.wilt@xxxxxxxxx>
wrote:

Anybody actually using one of the javadoc for RPGLE tools?

I've run across past posts, but thought it'd be worthwhile to
revisit.

I've found the following:

ILEDOCS (old) - http://iledocs.sourceforge.net/
ILEDOCS (new) - https://bitbucket.org/m1hael/iledocs
RPGDOC - https://sourceforge.net/projects/rpgdoc/
RPGLEDOC - http://systemideveloper.com/Downloads/RPGLEDOC.zip

Any I'm missing?

It seems Mihael's newer ILEDOCS is the only one currently
maintained,
but
from what I can tell, it doesn't yet have the RPGLE parsers
included.

I note there's a RFE for RDi..
https://www.ibm.com/developerworks/rfe/execute?
use_case=viewRfe&CR_ID=25264

I'd love for both RDi to take advantage of such info and for the
system
(RPG compiler?) to be able to generate HTML documentation.

Also wondering if one of the existing non-RPG tool is extendable
enough
to
use with RPG.

Thoughts?

Charles
--
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




--
Regards,
Henrik Rützou

http://powerEXT.com <http://powerext.com/>
--
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
--
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




--
Regards,
Henrik Rützou

http://powerEXT.com <http://powerext.com/>
--
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

--
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





As an Amazon Associate we earn from qualifying purchases.

This thread ...
Replies:
Follow On AppleNews
Return to Archive home page | Return to MIDRANGE.COM home page

This mailing list archive is Copyright 1997-2024 by midrange.com and David Gibbs as a compilation work. Use of the archive is restricted to research of a business or technical nature. Any other uses are prohibited. Full details are available on our policy page. If you have questions about this, please contact [javascript protected email address].

Operating expenses for this site are earned using the Amazon Associate program and Google Adsense.