Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-4830380

Inconsistent use of periods at end of -help usage descriptions

XMLWordPrintable



      Name: afR10219 Date: 03/11/2003



      Resource file for standard doclet contains the following usage. A part of
      statements has dots at the end, and other part does not have. This should
      be unified, i.e dots should be removed.


      Provided by Standard doclet:
      -d <directory> Destination directory for output files
      -use Create class and package usage pages
      -version Include @version paragraphs
      -author Include @author paragraphs
      -docfilessubdirs Recursively copy doc-file subdirectories
      -splitindex Split index into one file per letter
      -windowtitle <text> Browser window title for the documenation
      -doctitle <html-code> Include title for the overview page
      -header <html-code> Include header text for each page
      -footer <html-code> Include footer text for each page
      -bottom <html-code> Include bottom text for each page
      -link <url> Create links to javadoc output at <url>
      -linkoffline <url> <url2> Link to docs at <url> using package list at
      <url2>
      -excludedocfilessubdir <name1>:.. Exclude any doc-files subdirectories with
      given name.
      -group <name> <p1>:<p2>.. Group specified packages together in
      overview page
      -nocomment Supress description and tags, generate only
      declarations.
      -nodeprecated Do not include @deprecated information
      -noqualifier <name1>:<name2>:... Exclude the list of qualifiers from the
      output.
      -nosince Do not include @since information
      -nodeprecatedlist Do not generate deprecated list
      -notree Do not generate class hierarchy
      -noindex Do not generate index
      -nohelp Do not generate help link
      -nonavbar Do not generate navigation bar
      -quiet Do not display status messages to screen
      -serialwarn Generate warning about @serial tag
      -tag <name>:<locations>:<header> Specify single argument custom tags
      -taglet The fully qualified name of Taglet to
      register
      -tagletpath The path to Taglets
      -charset <charset> Charset for cross-platform viewing of
      generated documentation.
      -helpfile <file> Include file that help link links to
      -linksource Generate source in HTML
      -stylesheetfile <path> File to change style of the generated
      documentation
      -docencoding <name> Output encoding name




      ======================================================================

      Name: afR10219 Date: 03/11/2003



      I mean dots in descriptions. Not a big deal, but we should have a perfect
      product.

      > -charset <charset> Charset for cross-platform viewing of
      > generated documentation.

      Have a dot at the end (after 'documentation')

      > -quiet Do not display status messages to screen

      Have no dot.

      ======================================================================

            jjg Jonathan Gibbons
            duke J. Duke
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

              Created:
              Updated:
              Resolved:
              Imported:
              Indexed: