/[classpath]/gjdoc/docs/invoke.texi
ViewVC logotype

Diff of /gjdoc/docs/invoke.texi

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

revision 1.2 by julian, Thu Feb 17 15:10:46 2005 UTC revision 1.3 by julian, Mon May 23 21:54:09 2005 UTC
# Line 204  Doclet, grouped by type.  Explanations a Line 204  Doclet, grouped by type.  Explanations a
204    
205  @item Output Options  @item Output Options
206  @xref{Generation Options,,Options Controlling the Output}.  @xref{Generation Options,,Options Controlling the Output}.
207  @gccoptlist{-d  -locale @var{name}  -charset @var{charset}  -docencoding @var{charset}}  @gccoptlist{-d  -locale @var{name}  -charset @var{charset}  -docencoding @var{charset}
208     -validhtml  -baseurl @var{url}}
209    
210  @item Decoration Options  @item Decoration Options
211  @gccoptlist{-windowtitle @var{text}  -doctitle @var{text} @gol  -title @var{text}    @gccoptlist{-windowtitle @var{text}  -doctitle @var{text} @gol  -title @var{text}  
# Line 930  Examples for @var{charset} are @samp{US- Line 931  Examples for @var{charset} are @samp{US-
931  The semantics of this option correspond exactly to those of the  The semantics of this option correspond exactly to those of the
932  constructors of class @samp{java.util.Locale}.  constructors of class @samp{java.util.Locale}.
933    
934    @item -validhtml
935    @opindex validhtml
936    
937    Force generation of valid XHTML code.  This breaks compatibility to
938    the traditional Javadoc tool to some extent.
939    
940    If this option is specified, anchor names will be mangled so that they
941    are valid according to the XHTML 1.1 specification.  However, a
942    documentation set generated with this option cannot be linked to
943    properly using the traditional Javadoc tool.  It can be linked to just
944    fine using Gjdoc, though.
945    
946    Without this option, anchor names for executable class members use the
947    traditional format, for example: ``foo(String,int[])''.  This is
948    compatible to the traditional Javadoc tool, but according to both the
949    HTML 4.0 and XHTML 1.0 and 1.1 specifications, this format includes
950    illegal characters.  Parentheses, square brackets, and the comma are
951    not allowed in anchor names.
952    
953    @item -baseurl @var{url}
954    @opindex validhtml
955    
956    Hardwire a page URL relative to @var{url} into each generated page.
957    
958    If you are generating documentation which will exclusively be
959    available at a certain URL, you should use this option to specify this
960    URL.
961    
962    This can help avoid certain redirect attacks used by spammers, and it
963    can be helpful for certain web clients.
964    
965  @end table  @end table
966    
967  @node Verbosity Options  @node Verbosity Options

Legend:
Removed from v.1.2  
changed lines
  Added in v.1.3

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