Re: 3.3 branch, 3.3.1, 3.4, etc

[Brian Jones <cbj at gnu dot org>]

Brian Jones <cbj@gnu.org> writes:

> Tom Tromey <tromey@redhat.com> writes:
> 
> > >>>>> "Brian" == Brian Jones <cbj@gnu.org> writes:
> > 
> > Brian> Do you plan to include gjdoc with gcj?
> > 
> > Last I heard, gjdoc still had issues.  I don't know the nature of
> > them, since I haven't tried it out myself.  Do you have better
> > information about its state?
> 
> As far as I know it is essentially complete; refinements may be needed
> but the tool needs use as well.  I plan to start producing nightly
> docs from Classpath CVS shortly and to release API documentation with
> each Classpath release based on the output of gjdoc if at all possible.

Here is the information from the README with greater detail.  For an
example of the output, the Classpath API documentation is now
available from http://www.gnu.org/software/classpath/docs/api/.

...
`gjdoc' is a drop-in replacement for the command line tool `javadoc'
shipped with Sun's JDK.

It is written in pure Java and currently requires a 1.2 classpath.

`gjdoc' aims at implementing all features of Sun's Javadoc 1.3, while
maintaining full compatibility. Currently, around 90% of the Doclet
API is implemented.

However, in contrast to Javadoc, `gjdoc' does not perfom syntax
checking on the supplied sources. If necessary, use something like
`jikes +B' for checking your sources beforehand.
...
2. Missing Features
------------------------------------------------------------------------------

This preview version does not contain the following features:

- No Javadoc 1.4 functionality.
  For example, Taglets are not supported.

- Tags:
    @serial
    @serialData
    @serialField
    {@docRoot}

- Command Line Options:
    -overview
    -docletpath
    -1.1
    -bootclasspath
    -extdirs
    -verbose
    -locale
    -encoding
    -J<flag>

- Known Bugs:
    @see and @link tags are not always interpreted correctly.
...
And you can use gcj (the GNU Compiler for Java - tested with version 3.2)
to compile it all into a nice binary:

  cd src; gcj -o ../bin/gjdoc --main=gnu.classpath.tools.gjdoc.Main \
      gnu/classpath/tools/gjdoc/*.java com/sun/javadoc/*.java \
      gnu/classpath/tools/doclets/xmldoclet/*.java

-- 
Brian Jones <cbj@gnu.org>
http://www.haphazard.org/~cbj/