NrxDoc -- a NetRexx compatible version of Java Doc

[Thomas.Schneider.Wien]

  Hello there,

    before I do invest too much time into something already available:

I did invest now some time to re-read the most recent version of the
NetRexx2 specification of MFC
(so well done,  as always, Mr. M.F.Cowlishaw :-)) , and also JavaDoc.

For the upcoming release of ReyC, I would like to *use* OR *write* a
NetRexx compatible version of
of JavaDoc.

In order to do so, I just wrote a small utility of my own to translate
my (very historical) type of documentation
(my *own* comment style, which is actually currenlty influenced by
Rexx2Nrx, and my own style used for years)
to the now more common Java Doc style....

I did call it Rexx2Doc.

Now, before going further, I would like to know, if there is already
available a tool  producing a Java
Doc out of the given NetRexx sources in a given directory (and it's
subdirectories, when wanted)

(assuming that all COMMENTS in the source (including @tags and {@tags}
conform to the JavaDoc style)

When you, by fortune, did already invest in such a tool, please let me know.

My planned NrxDoc will take all paramters from *external* options etc
files, conforming to JavaDoc.
You thus will *not have* all the options available on the command line,
but you may define
them as you like in external files ..

Don't hesitate to send me your source to [hidden email] when you already
did (or 80% did)
what I'm trying to do..... :-)

Tom (Thomas Schneider)

PS: My utility will work on a whole directory, going recursively thru
all sub-directories by default.




--
Thomas Schneider Projects ReyC & LOGOS on www.KENAI.com
_______________________________________________
Ibm-netrexx mailing list
[hidden email]

[rvjansen]

Thomas,

it is perfectly feasible to run javadoc. Only recently, on 11 - 8 -  2010 21:27:15 GMT+02:00 K P Kirchdoerfer posted an ant script that can do it. I do something similar using make, the key is using the -comments flag to preserve these in the generated java source.

Nrxdoc has been around as a tool and a name, and if you choose to recreate something like that, you probably should choose another name.

best regards,

René Vincent Jansen.

On 18 aug 2010, at 19:31, Thomas Schneider wrote:

> Hello there,
>
>   before I do invest too much time into something already available:
>
> I did invest now some time to re-read the most recent version of the NetRexx2 specification of MFC
> (so well done,  as always, Mr. M.F.Cowlishaw :-)) , and also JavaDoc.
>
> For the upcoming release of ReyC, I would like to *use* OR *write* a NetRexx compatible version of
> of JavaDoc.
>
> In order to do so, I just wrote a small utility of my own to translate my (very historical) type of documentation
> (my *own* comment style, which is actually currenlty influenced by Rexx2Nrx, and my own style used for years)
> to the now more common Java Doc style....
>
> I did call it Rexx2Doc.
>
> Now, before going further, I would like to know, if there is already available a tool  producing a Java
> Doc out of the given NetRexx sources in a given directory (and it's subdirectories, when wanted)
>
> (assuming that all COMMENTS in the source (including @tags and {@tags} conform to the JavaDoc style)
>
> When you, by fortune, did already invest in such a tool, please let me know.
>
> My planned NrxDoc will take all paramters from *external* options etc files, conforming to JavaDoc.
> You thus will *not have* all the options available on the command line, but you may define
> them as you like in external files ..
>
> Don't hesitate to send me your source to [hidden email] when you already did (or 80% did)
> what I'm trying to do..... :-)
>
> Tom (Thomas Schneider)
>
> PS: My utility will work on a whole directory, going recursively thru all sub-directories by default.
>
>
>
>
> --
> Thomas Schneider Projects ReyC & LOGOS on www.KENAI.com
> _______________________________________________
> Ibm-netrexx mailing list
> [hidden email]
>

_______________________________________________
Ibm-netrexx mailing list
[hidden email]

[Tom Maynard]

  On 8/18/2010 12:31 PM, Thomas Schneider wrote:
>
> Now, before going further, I would like to know, if there is already
> available a tool  producing a Java
> Doc out of the given NetRexx sources in a given directory (and it's
> subdirectories, when wanted)
>
Take a look at Doxygen (http://www.stack.nl/~dimitri/doxygen/),
available under the GNU General Public License.


_______________________________________________
Ibm-netrexx mailing list
[hidden email]

[KP Kirchdörfer]

Am Mittwoch, 18. August 2010, 19:54:09 schrieben Sie:
> it is perfectly feasible to run javadoc. Only recently, on 11 - 8 -  2010
> 21:27:15 GMT+02:00 K P Kirchdoerfer posted an ant script that can do it.

Nice that one is referring to my mail as a possible solution; in fact it was
written as a query, if anyone has an idea how I can create javadocs for inner
classes as well with ant :)

kp

_______________________________________________
Ibm-netrexx mailing list
[hidden email]