[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Fwd: Re: [Cp-tools-discuss] Cp-tools Javadoc Overview (was Re: Classpat
From: |
Julian Scheid |
Subject: |
[Fwd: Re: [Cp-tools-discuss] Cp-tools Javadoc Overview (was Re: Classpath API javadoc)] |
Date: |
Thu, 12 Dec 2002 23:47:40 +0100 |
User-agent: |
Mozilla/5.0 (Windows; U; Windows NT 5.0; en-US; rv:1.2) Gecko/20021126 |
Not sure if it's still up-to-date, but I remember I found it a good
summary back then.
I'm currently digging for generate-classpath-docs.sh, it must be somewhere.
Julian
-------- Original Message --------
Subject: Re: [Cp-tools-discuss] Cp-tools Javadoc Overview (was Re:
Classpath API javadoc)
From: Mark Wielaard <address@hidden>
To: Julian Scheid <address@hidden>
Cc: address@hidden, address@hidden
In-Reply-To: <address@hidden>
References: <address@hidden>
<address@hidden> <address@hidden>
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
- [Fwd: Re: [Cp-tools-discuss] Cp-tools Javadoc Overview (was Re: Classpath API javadoc)],
Julian Scheid <=