Re: Could there be a gcj-doc?

[Alan Langford <jal at ambitonline dot com>]

I have a source formatting idiosyncrasy that says that all documentation 
for a block should be inside the block it's documenting:

class Fred() {
/* This class blah blah blah */
}

rather than

/* This class blah blah blah */
class Fred() {
}

Makes logical sense to me, it makes the header comments part of the block 
rather than some disconnected preamble.

Unfortunately, that's not how javadoc wants things set up. So I have been 
looking for free source that I could use as a base for building a version 
that does things the way I want. The closest I could find to this is a 
project on sourceforge.net called JDocHelper. It's intended to provide 
automated assistance for developers adding javadoc comments to their source 
files. However, it seems to me that is has the core functionality required 
to build a free version of javadoc. What it won't have is some of the 
extensibility that javadoc provides, although it probably wouldn't be that 
hard to implement.

If there's anything more appropriate, I'd be very interested in knowing 
about it as well. If someone wants to start a gcj-doc project and Java is 
picked as the implementation language, I'd be willing to contribute to it.

At 2001/06/14 12:24 -0700, Adrian Custer wrote:
>This is probably one for the FAQ. I wondered about javadoc if I'm using
>gcj. I know many projects/languages are using javadoc like tags to
>generate automatic documentation. Is there a way to use a Free software
>package to generate documentation from my code? Do we still need the
>Blackdown/Sun javadoc package to get documentation for all the base
>classes? I would be really excited if gcj had a companion gcjdoc program
>and I suspect that I can use some program that already exists.

--------------
Alan Langford   jal@ambitonline.com
Ambit Perspectives      (416)621-9899