[Cp-tools-discuss] Gjdoc Release 0.4.1

[Julian Scheid]

gjdoc 0.4.1 available in CVS. Finally, HTML generation is the
default.

Libxslt is still required however. I hope that I can get it to
work with Classpathx's JAXP down the road.

You can now generate HTML documentation as easy as:

  gjdoc -d docs/ -sourcepath src/ some.package.name

Assumes that you have compiled gjdoc using gcj and put it on
your path, and xsltproc is on your path.

Using a VM it's a bit more cumbersome at the time:

  java -jar /path/to/gjdoc.jar -d docs/ -sourcepath src/
        some.package.name

Both will create a temporary directory for interim XML files,
run xsltproc as a separate process (putting the HTML files
into the user specified target directory), and clean up
when done.

Relevant part of latest README follows below. Running gjdoc
without arguments should give a fairly accurate listing of
available options.

Note that the executable does not work with @argument files
when compiled with gcj 3.2.1, apparently because of a bug
in StreamTokenizer. I'll investigate.

Also note that the Ant build file is not necessarily meant as
a final solution. If someone can come up with an alternative
build approach that does not depend on non-GNU software,
please go ahead. I'll concentrate on other issues for now.

Let me know how it works for you.

Julian


Taken from README for 0.4.1
> This version includes an Ant build file. To use it, make sure that
> ant, java, javac, gcj and xsltproc all are on your path. Your gcj
> needs to support threads.
>
> Using Ant you can build the distribution as follows:
>  
>   cvs co gjdoc
>   cd gjdoc
>
>   cd src
>
>   # --- Produce gjdoc/dist/gjdoc.jar
>   ant              
>
>   # --- Optionally produce gjdoc/dist/gjdoc executable
>   ant gcj          
>
>   cd ..
>
>   # --- Test package by having it generate documentation for its own sources
>
>   examples/gjdoc-docs.sh
>   ls tmp/gjdoc-api-html
>
>   # --- Test package by having it generate the full documentation for the
>   # --- GNU Classpath API. This can take some time
>
>   examples/classpath-docs.sh /path/to/classpath
>   ls tmp/classpath-api-html