1 |
|
|
2 |
gjdoc - A doclet driver for the Java platform. |
gjdoc - A doclet driver for the Java platform. |
3 |
Copyright (C) 2001 Free Software Foundation |
Copyright (C) 2001, 2002, 2003, 2004, 2005 Free Software Foundation |
4 |
|
|
5 |
This program is free software; you can redistribute it and/or modify |
This program is free software; you can redistribute it and/or modify |
6 |
it under the terms of the GNU General Public License as published by |
it under the terms of the GNU General Public License as published by |
21 |
|
|
22 |
Doclet driver with standard Doclet. |
Doclet driver with standard Doclet. |
23 |
|
|
24 |
Version 0.4.1 |
Version 0.7.1 |
25 |
(C) 2001, 2002, 2003, 2004 Free Software Foundation |
(C) 2001, 2002, 2003, 2004, 2005 Free Software Foundation |
26 |
|
|
27 |
Released under the GNU General Public License (GPL). |
Released under the GNU General Public License (GPL). |
28 |
|
|
30 |
2. Missing Features |
2. Missing Features |
31 |
3. Installation |
3. Installation |
32 |
4. Usage |
4. Usage |
33 |
5. Evaluation |
5. Feedback |
|
6. Feedback |
|
34 |
|
|
35 |
1. Overview |
1. Overview |
36 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
37 |
|
|
38 |
`gjdoc' is a drop-in replacement for the command line tool `javadoc' |
Gjdoc is a drop-in replacement for the command line tool `javadoc' |
39 |
shipped with Sun's JDK. |
shipped with Sun's JDK. |
40 |
|
|
41 |
It is written in pure Java and requires a 1.2 classpath. |
Gjdoc's current version implements all features of Sun's Javadoc 1.4. |
42 |
|
It should be command-line compatible and provide a compatible Doclet |
43 |
`gjdoc' aims at implementing all features of Sun's Javadoc 1.4, while |
API. |
|
maintaining full compatibility. Currently, around 90% of the Doclet |
|
|
API is implemented. |
|
44 |
|
|
45 |
However, in contrast to Javadoc, `gjdoc' does not perfom syntax |
However, in contrast to Javadoc, `gjdoc' does not perfom syntax |
46 |
checking on the supplied sources. If necessary, use something like |
checking on the supplied sources. If necessary, use something like |
47 |
`jikes +B' for checking the sources beforehand. |
`jikes +B' for checking the sources beforehand. |
48 |
|
|
49 |
The gjdoc package also contains a standard doclet which allows you to |
The gjdoc package ships with a standard doclet for generating HTML |
50 |
generate XML code and HTML code (HTML code generation currently |
output. |
|
requires libxslt). |
|
51 |
|
|
52 |
This tool is a subproject of the GNU Classpath project. |
This tool is a part of GNU Classpath-tools. |
53 |
See http://www.gnu.org/software/classpath/ |
See http://www.gnu.org/software/classpath/cp-tools/ |
54 |
|
|
55 |
|
|
56 |
2. Missing Features |
2. Missing Features |
57 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
58 |
|
|
59 |
- No Javadoc 1.4 functionality. |
- No Javadoc 1.5 functionality. |
60 |
For example, Taglets are not supported. |
For example, the new 1.5 language features are not supported. |
61 |
|
|
|
- Tags: |
|
|
@serial |
|
|
@serialData |
|
|
@serialField |
|
|
{@docRoot} |
|
|
|
|
|
- Command Line Options: |
|
|
-overview |
|
|
-docletpath |
|
|
-1.1 |
|
|
-bootclasspath |
|
|
-extdirs |
|
|
-verbose |
|
|
-locale |
|
|
-encoding |
|
|
-J<flag> |
|
62 |
|
|
63 |
- Known Bugs: |
3. Installation |
|
@see and @link tags are not always interpreted correctly. |
|
|
|
|
|
3. Installing |
|
64 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
65 |
|
|
66 |
This version includes an Ant build file. To use it, make sure that |
Generic installation instructions apply: |
67 |
ant, java, javac, gcj and xsltproc all are on your path. Your gcj |
./configure && make && sudo make install |
|
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 |
|
68 |
|
|
69 |
cd .. |
See INSTALL for further details. |
70 |
|
|
71 |
# --- Test package by having it generate documentation for its own sources |
Gjdoc is known to build with GNU GCJ 4.0 and jikes 1.21. It is known |
72 |
|
to run on GCJ 4.0, kaffe x.x and jamvm 1.2.3. |
73 |
|
|
74 |
examples/gjdoc-docs.sh |
You will also need ANTLR 2.7.1 or better installed. See http://antlr.org/. |
|
ls tmp/gjdoc-api-html |
|
75 |
|
|
76 |
# --- Test package by having it generate the full documentation for the |
There are known problems with the current version of kaffe's jar tool |
77 |
# --- GNU Classpath API. This can take some time |
(as of Feburary 2005) which is the default on some platforms. Use the |
78 |
|
JAR environment variable to specify a different jar tool if the build |
79 |
examples/classpath-docs.sh /path/to/classpath |
hangs while assembling the jar file or if you get the error message |
80 |
ls tmp/classpath-api-html |
"FATAL ERROR: No more room for local references". |
|
|
|
|
An automakejar based build coming up soon. |
|
|
|
|
|
|
|
|
3.1 Manual installation |
|
|
------------------------------------------------------------------------------ |
|
|
|
|
|
For now, just compile all sources and put them on your classpath |
|
|
or into a jarball. Currently, when running the tool you need to |
|
|
make sure that gjdoc is the current directory. |
|
|
|
|
|
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 |
|
81 |
|
|
82 |
|
|
83 |
4. Usage |
4. Usage |
91 |
5. Feedback |
5. Feedback |
92 |
------------------------------------------------------------------------------ |
------------------------------------------------------------------------------ |
93 |
|
|
94 |
|
Please file bugs at http://savannah.gnu.org/bugs/?group=classpath in |
95 |
|
category `gjdoc'. |
96 |
|
|
97 |
Please send comments and suggestions to <cp-tools-discuss@gnu.org>. |
Please send comments and suggestions to <cp-tools-discuss@gnu.org>. |