Re: [Cp-tools-discuss] Cp-tools Javadoc Overview (was Re: Classpath API javadoc)

[Mark Wielaard]

Hi,

On Sun, 2002-04-28 at 15:08, Julian Scheid wrote:
> 
> If there are any build issues with the tools (especially with
> Gjdoc and the XML doclet, which are not yet autoconf'ing AFAIK)
> I'll be glad to help - just post to <address@hidden>.

Just a quick note for people trying out gjdoc since the Makefile
included did not help me very much I compiled by hand as follows:

- Checkout gjdoc from subversion
  cvs -z3 -d:pserver:address@hidden:/cvsroot/cp-tools \
      checkout gjdoc
- Copy the com/sun/javadoc sources from the Classpath source tree
  into the new gjdoc directory.
  (I think it would be a good idea to move these sources from the main
   Classpath source tree to the gjdoc source tree.)
- The file gnu/classpath/tools/doclets/xmldoclet/HtmlWell.java
  contains an unreadable (on my system) character on like 53.
  It should probably be replace it with \u00a7 (section sign).
- Use gcj to compile it all into a nice binary
  gcj -o gjdoc --main=gnu.classpath.tools.gjdoc.Main \
      gnu/classpath/tools/gjdoc/*.java com/sun/javadoc/*.java \
      gnu/classpath/tools/doclets/xmldoclet/*.java

Now you can play a bit with the included xmldoclet as follows:

 - Run gjdoc on its own source
   ./gjdoc -sourcepath \
      .:/home/mark/src/classpath:/home/mark/src/classpath/vm/reference \
      -doclet gnu.classpath.tools.doclets.xmldoclet.Driver \
      gnu.classpath.tools.gjdoc > output.xml
   (This does give a lot of ERROR messages so this is propably not the
    correct invocation. But it does produce output.)
 - Use your favorite XSLT processor to turn the XML into HTML
   xsltproc xslt/gjdocxml2html.xsl output.xml > index.html

The output looks nice. Now I am going to try out the texidoclet.

Thanks,

Mark