/[classpath]/gjdoc/README
ViewVC logotype

Diff of /gjdoc/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 1.12 by julian, Fri Feb 4 17:41:16 2005 UTC revision 1.13 by julian, Sat Feb 5 17:21:40 2005 UTC
# Line 1  Line 1 
1    
2      gjdoc - A doclet driver for the Java platform.      gjdoc - A documentation generation framework for java source files.
3      Copyright (C) 2001, 2002, 2003, 2004, 2005 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
# Line 16  Line 16 
16      along with this program; if not, write to the Free Software      along with this program; if not, write to the Free Software
17      Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA      Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
18    
19        Includes Java2xhtml distributed under the same terms with the following
20        notice: Copyright (C) 2003 Shayne Steele
21        License and warranty are under the terms of the GNU General Public License
22        Version 2.0.  See http://www.gnu.org for license and warranty details.
23    
24  gjdoc  gjdoc
25  =====  =====
26    
27  Doclet driver with standard Doclet.  Documentation generation framework for java source files.
28    
29  Version 0.7.1  Version 0.7.1
30  (C) 2001, 2002, 2003, 2004, 2005 Free Software Foundation  (C) 2001, 2002, 2003, 2004, 2005 Free Software Foundation
# Line 27  Version 0.7.1 Line 32  Version 0.7.1
32  Released under the GNU General Public License (GPL).  Released under the GNU General Public License (GPL).
33    
34  1. Overview  1. Overview
35  2. Missing Features  2. Installation
36  3. Installation  3. Usage
37  4. Usage  4. Missing Features
38  5. Feedback  5. Feedback
39    
40  1. Overview  1. Overview
41  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
42    
43  Gjdoc is a drop-in replacement for the command line tool `javadoc'  Gjdoc is a documentation framework for generating documentation in
44  shipped with Sun's JDK.  various formats from java source file.  It is both a drop-in
45    replacement for the traditional command line tool `javadoc' and
46  Gjdoc's current version implements all features of Sun's Javadoc 1.4.  provides an interface for inspection of and generation of different
47  It should be command-line compatible and provide a compatible Doclet  output for java source packages, classes, methods and fields.
48  API.  
49    Gjdoc's current version implements all features of the traditional
50  However, in contrast to Javadoc, `gjdoc' does not perfom syntax  javadoc tool up to version 1.4.  It should be fully command-line
51  checking on the supplied sources. If necessary, use something like  compatible and provides a compatible Doclet API (com.sun.javadoc).
52  `jikes +B' for checking the sources beforehand.  
53    However, in contrast to Javadoc, `gjdoc' does not perfom syntax
54    checking on the supplied sources. If necessary, use a real compiler
55    like `gcj -fsyntax-only` or `jikes +B' for checking the sources
56    beforehand.
57    
58  The gjdoc package ships with a standard doclet for generating HTML  The gjdoc package ships with a standard doclet for generating HTML
59  output.  output (the default).
60    
61    A debug doclet which just prints (not yet) all information to
62    System.out and which can be used to explore the doclet interface.
63    (enabled by -doclet gnu.classpath.tools.doclets.debugdoclet.DebugDoclet)
64    
65    And a doclet that generates output in XML format, which can then be
66    postprocessed into other formats with xslt tools like xsltproc or the
67    javax.xml.transform package of GNU JAXP and/or GNU Classpath.  (Only
68    available when configured with --enable-xmldoclet and enabled by
69    -doclet gnu.classpath.tools.doclets.xmldoclet.Driver)
70    
71  This tool is a part of GNU Classpath-tools.  This tool is a part of GNU Classpath-tools.
72  See http://www.gnu.org/software/classpath/cp-tools/  See http://www.gnu.org/software/classpath/cp-tools/
73    
74    
 2. Missing Features  
 ------------------------------------------------------------------------------  
   
 - No Javadoc 1.5 functionality.  
   For example, the new 1.5 language features are not supported.  
   
75    
76  3. Installation  2. Installation
77  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
78    
79  Generic installation instructions apply:  Generic installation instructions apply:
# Line 69  Generic installation instructions apply: Line 82  Generic installation instructions apply:
82  See INSTALL for further details.  See INSTALL for further details.
83    
84  Gjdoc is known to build with GNU GCJ 4.0 and jikes 1.21. It is known  Gjdoc is known to build with GNU GCJ 4.0 and jikes 1.21. It is known
85  to run on GCJ 4.0, kaffe x.x and jamvm 1.2.3.  to run on GCJ 4.0, kaffe (CVS of February 5 2005) and jamvm 1.2.3.
86    
87  You will also need ANTLR 2.7.1 or better installed. See http://antlr.org/.  You will also need ANTLR 2.7.1 or better installed. See http://antlr.org/.
88    
89  There are known problems with the current version of kaffe's jar tool  For a couple of know build and runtime problems please see the file
90  (as of Feburary 2005) which is the default on some platforms. Use the  TROUBLESHOOTING.
 JAR environment variable to specify a different jar tool if the build  
 hangs while assembling the jar file or if you get the error message  
 "FATAL ERROR: No more room for local references".  
91    
92    
93  4. Usage  3. Usage
94  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------
95    
96  Run `gjdoc' without parameters for further usage information.  USAGE: gjdoc [options] [packagenames] [sourcefiles] [@files]
97    
98      --version                Show version information and exit
99      -overview <file>         Read overview documentation from HTML file
100      -public                  Include only public classes and members
101      -protected               Include protected and public classes and members
102                               This is the default
103      -package                 Include package/protected/public classes and members
104      -private                 Include all classes and members
105      -help                    Show this information
106      -doclet <class>          Doclet class to use for generating output
107      -docletpath <classpath>  Specifies the search path for the doclet and
108                               dependencies
109      -source <release>        Provide source compatibility with specified
110                               release (1.4 to handle assertion)
111      -sourcepath <pathlist>   Where to look for source files
112      -verbose                 Output messages about what Gjdoc is doing [ignored]
113      -quiet                   Do not print non-error and non-warning messages
114      -locale <name>           Locale to be used, e.g. en_US or en_US_WIN [ignored]
115      -encoding <name>         Source file encoding name
116      -breakiterator           Compute first sentence with BreakIterator
117      -classpath               Set the path used for loading auxilliary classes
118    
119    Gjdoc extension options:
120      -licensetext            Include license text from source files
121    
122    Standard doclet options:
123      -d                      Set target directory
124      -use                    Includes the 'Use' page for each documented class
125                              and package
126      -version                Includes the '@version' tag
127      -author                 Includes the '@author' tag
128      -splitindex             Splits the index file into multiple files
129      -windowtitle <text>     Browser window title
130      -doctitle <text>        Title near the top of the overview summary file
131                              (html allowed)
132      -title <text>           Title for this set of API documentation
133                              (deprecated, -doctitle should be used instead)
134      -header <text>          Text to include in the top navigation bar
135                              (html allowed)
136      -footer <text>          Text to include in the bottom navigation bar
137                              (html allowed)
138      -bottom <text>          Text to include at the bottom of each output file
139                              (html allowed)
140      -link <extdoc URL>      Link to external generated documentation at URL
141      -linkoffline <extdoc URL> <packagelistLoc>
142                              Link to external generated documentation for
143                              the specified package-list
144      -linksource             Creates an HTML version of each source file
145      -group <groupheading> <packagepattern:packagepattern:...>
146                              Separates packages on the overview page into groups
147      -nodeprecated           Prevents the generation of any deprecated API
148      -nodeprecatedlist       Prevents the generation of the file containing
149                              the list of deprecated APIs and the link to the
150                              navigation bar to that page
151      -nosince                Omit the '@since' tag
152      -notree                 Do not generate the class/interface hierarchy page
153      -noindex                Do not generate the index file
154      -nohelp                 Do not generate the HELP link
155      -nonavbar               Do not generate the navbar, header and footer
156      -helpfile <filen>       Path of an alternate help file
157      -stylesheetfile <file>  Path of an alternate html stylesheet
158      -charset <IANACharset>  Specifies the HTML charset
159      -docencoding <IANACharset>
160                              Specifies the encoding of the generated HTML files
161      -tag <tagname>:Xaoptcmf:"<taghead>"
162                              Enables gjdoc to interpret a custom tag
163      -taglet                 Adds a Taglet class to the map of taglets
164      -tagletpath             Sets the CLASSPATH to load subsequent Taglets from
165      -subpackages <spkglist> List of subpackages to recursively load
166      -exclude <pkglist>      List of packages to exclude
167      -docfilessubdirs        Enables deep copy of 'doc-files' directories
168      -excludedocfilessubdir <name1:name2:...>
169                              Excludes 'doc-files' subdirectories with a give
170    
171  More information coming soon.  
172    4. Missing Features
173    ------------------------------------------------------------------------------
174    
175    - No Javadoc 1.5 functionality.
176      For example, the new 1.5 language features are not supported.
177    
178    
179  5. Feedback  5. Feedback

Legend:
Removed from v.1.12  
changed lines
  Added in v.1.13

savannah-hackers-public@gnu.org
ViewVC Help
Powered by ViewVC 1.1.26