/[classpath]/gjdoc/README
ViewVC logotype

Diff of /gjdoc/README

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

revision 1.14 by mark, Sat Feb 5 22:53:51 2005 UTC revision 1.15 by julian, Sun Feb 6 21:51:40 2005 UTC
# Line 47  provides an interface for inspection of Line 47  provides an interface for inspection of
47  output for java source packages, classes, methods and fields.  output for java source packages, classes, methods and fields.
48    
49  Gjdoc's current version implements all features of the traditional  Gjdoc's current version implements all features of the traditional
50  javadoc tool up to version 1.4.  It should be fully command-line  javadoc tool up to version 1.4.  With the exception of two
51  compatible and provides a compatible Doclet API (com.sun.javadoc).  unimplemented options (-nocomment and -serialwarn) it should be fully
52    command-line compatible, and it provides a compatible Doclet API
53    (com.sun.javadoc).
54    
55  However, in contrast to Javadoc, `gjdoc' does not perfom syntax  However, in contrast to Javadoc, `gjdoc' does not perfom syntax
56  checking on the supplied sources. If necessary, use a real compiler  checking on the supplied sources. If necessary, use a real compiler
# Line 96  TROUBLESHOOTING. Line 98  TROUBLESHOOTING.
98  USAGE: gjdoc [options] [packagenames] [sourcefiles] [@files]  USAGE: gjdoc [options] [packagenames] [sourcefiles] [@files]
99    
100    --version                Show version information and exit    --version                Show version information and exit
101      -all                     Process all source files found in the source path
102    -overview <file>         Read overview documentation from HTML file    -overview <file>         Read overview documentation from HTML file
103    -public                  Include only public classes and members    -public                  Include only public classes and members
104    -protected               Include protected and public classes and members    -protected               Include protected and public classes and members
105                             This is the default                             This is the default
106    -package                 Include package/protected/public classes and members    -package                 Include package/protected/public classes and members
107    -private                 Include all classes and members    -private                 Include all classes and members
108    -help                    Show this information    -help, --help            Show this information
109    -doclet <class>          Doclet class to use for generating output    -doclet <class>          Doclet class to use for generating output
110    -docletpath <classpath>  Specifies the search path for the doclet and    -docletpath <classpath>  Specifies the search path for the doclet and
111                             dependencies                             dependencies
112    -source <release>        Provide source compatibility with specified    -source <release>        Provide source compatibility with specified
113                             release (1.4 to handle assertion)                             release (1.4 to handle assertion)
114    -sourcepath <pathlist>   Where to look for source files    -sourcepath <pathlist>   Where to look for source files
115      -subpackages <spkglist>  List of subpackages to recursively load
116      -exclude <pkglist>       List of packages to exclude
117    -verbose                 Output messages about what Gjdoc is doing [ignored]    -verbose                 Output messages about what Gjdoc is doing [ignored]
118    -quiet                   Do not print non-error and non-warning messages    -quiet                   Do not print non-error and non-warning messages
119    -locale <name>           Locale to be used, e.g. en_US or en_US_WIN [ignored]    -locale <name>           Locale to be used, e.g. en_US or en_US_WIN
120    -encoding <name>         Source file encoding name    -encoding <name>         Source file encoding name
121    -breakiterator           Compute first sentence with BreakIterator    -breakiterator           Compute first sentence with BreakIterator
122    -classpath               Set the path used for loading auxilliary classes    -classpath <pathlist>    Set the path used for loading auxilliary classes
   
 Gjdoc extension options:  
   -licensetext            Include license text from source files  
123    
124  Standard doclet options:  Standard doclet options:
125    -d                      Set target directory    -d                      Set target directory
# Line 128  Standard doclet options: Line 130  Standard doclet options:
130    -splitindex             Splits the index file into multiple files    -splitindex             Splits the index file into multiple files
131    -windowtitle <text>     Browser window title    -windowtitle <text>     Browser window title
132    -doctitle <text>        Title near the top of the overview summary file    -doctitle <text>        Title near the top of the overview summary file
133                            (html allowed)                            (HTML allowed)
134    -title <text>           Title for this set of API documentation    -title <text>           Title for this set of API documentation
135                            (deprecated, -doctitle should be used instead)                            (deprecated, -doctitle should be used instead)
136    -header <text>          Text to include in the top navigation bar    -header <text>          Text to include in the top navigation bar
137                            (html allowed)                            (HTML allowed)
138    -footer <text>          Text to include in the bottom navigation bar    -footer <text>          Text to include in the bottom navigation bar
139                            (html allowed)                            (HTML allowed)
140    -bottom <text>          Text to include at the bottom of each output file    -bottom <text>          Text to include at the bottom of each output file
141                            (html allowed)                            (HTML allowed)
142    -link <extdoc URL>      Link to external generated documentation at URL    -link <extdoc URL>      Link to external generated documentation at URL
143    -linkoffline <extdoc URL> <packagelistLoc>    -linkoffline <extdoc URL> <packagelistLoc>
144                            Link to external generated documentation for                            Link to external generated documentation for
# Line 151  Standard doclet options: Line 153  Standard doclet options:
153    -nosince                Omit the '@since' tag    -nosince                Omit the '@since' tag
154    -notree                 Do not generate the class/interface hierarchy page    -notree                 Do not generate the class/interface hierarchy page
155    -noindex                Do not generate the index file    -noindex                Do not generate the index file
156    -nohelp                 Do not generate the HELP link    -nohelp                 Do not generate the help link
157    -nonavbar               Do not generate the navbar, header and footer    -nonavbar               Do not generate the navbar, header and footer
158    -helpfile <filen>       Path of an alternate help file    -helpfile <filen>       Path of an alternate help file
159    -stylesheetfile <file>  Path of an alternate html stylesheet    -stylesheetfile <file>  Path of an alternate HTML stylesheet
160    -charset <IANACharset>  Specifies the HTML charset    -charset <IANACharset>  Specifies the HTML charset
161    -docencoding <IANACharset>    -docencoding <IANACharset>
162                            Specifies the encoding of the generated HTML files                            Specifies the encoding of the generated HTML files
# Line 162  Standard doclet options: Line 164  Standard doclet options:
164                            Enables gjdoc to interpret a custom tag                            Enables gjdoc to interpret a custom tag
165    -taglet                 Adds a Taglet class to the map of taglets    -taglet                 Adds a Taglet class to the map of taglets
166    -tagletpath             Sets the CLASSPATH to load subsequent Taglets from    -tagletpath             Sets the CLASSPATH to load subsequent Taglets from
   -subpackages <spkglist> List of subpackages to recursively load  
   -exclude <pkglist>      List of packages to exclude  
167    -docfilessubdirs        Enables deep copy of 'doc-files' directories    -docfilessubdirs        Enables deep copy of 'doc-files' directories
168    -excludedocfilessubdir <name1:name2:...>    -excludedocfilessubdir <name1:name2:...>
169                            Excludes 'doc-files' subdirectories with a give name                            Excludes 'doc-files' subdirectories with a give name
170    -noqualifier all|<packagename1:packagename2:...>    -noqualifier all|<packagename1:packagename2:...>
171                            Do never fully qualify given pacakge names                            Do never fully qualify given package names
172    
173    Gjdoc extension options:
174      -licensetext            Include license text from source files
175    
176    
177  4. Missing Features  4. Missing Features
# Line 177  Standard doclet options: Line 180  Standard doclet options:
180  - No Javadoc 1.5 functionality.  - No Javadoc 1.5 functionality.
181    For example, the new 1.5 language features are not supported.    For example, the new 1.5 language features are not supported.
182    
183    - The -nocomment and -serialwarn options are currently not
184      implemented.
185    
186    
187  5. Feedback  5. Feedback
188  ------------------------------------------------------------------------------  ------------------------------------------------------------------------------

Legend:
Removed from v.1.14  
changed lines
  Added in v.1.15

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