javadoc


DevX Home    Today's Headlines   Articles Archive   Tip Bank   Forums   

Results 1 to 2 of 2

Thread: javadoc

  1. #1
    Join Date
    May 2004
    Posts
    1

    javadoc

    When I create a javadoc I am having problems with the format of my parameters inside the html page that is created. I am getting java.lang.String in the parameter list wher I would like to have just String . Not sure this is possible, but the entire path name for the Stiring makes the parameter list look a little sloppy.

  2. #2
    Join Date
    Feb 2004
    Posts
    808
    i'd imagine it's one of the javadoc options:

    Code:
    C:\javawork\trash>javadoc
    javadoc: No packages or classes specified.
    usage: javadoc [options] [packagenames] [sourcefiles] [classnames] [@files]
    -overview <file>          Read overview documentation from HTML file
    -public                   Show only public classes and members
    -protected                Show protected/public classes and members (default)
    -package                  Show package/protected/public classes and members
    -private                  Show all classes and members
    -help                     Display command line options and exit
    -doclet <class>           Generate output via alternate doclet
    -docletpath <path>        Specify where to find doclet class files
    -sourcepath <pathlist>    Specify where to find source files
    -classpath <pathlist>     Specify where to find user class files
    -exclude <pkglist>        Specify a list of packages to exclude
    -subpackages <subpkglist> Specify subpackages to recursively load
    -breakiterator            Compute 1st sentence with BreakIterator
    -bootclasspath <pathlist> Override location of class files loaded
                              by the bootstrap class loader
    -source <release>         Provide source compatibility with specified release
    -extdirs <dirlist>        Override location of installed extensions
    -verbose                  Output messages about what Javadoc is doing
    -locale <name>            Locale to be used, e.g. en_US or en_US_WIN
    -encoding <name>          Source file encoding name
    -J<flag>                  Pass <flag> directly to the runtime system
    
    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
    1 error
    but which one, i have no idea..

    you could try everything and if it goes away, then just try half of the options, if it comes back, it was in the other half.. and so on.. binary chop style

    which would probably be faster than looking for the info out there..
    The 6th edict:
    "A thing of reference thing can hold either a null thing or a thing to any thing whose thing is assignment compatible with the thing of the thing" - ArchAngel, www.dictionary.com et al.
    JAR tutorial GridBag tutorial Inherited Shapes Inheritance? String.split(); FTP?

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  
HTML5 Development Center
 
 
FAQ
Latest Articles
Java
.NET
XML
Database
Enterprise
Questions? Contact us.
C++
Web Development
Wireless
Latest Tips
Open Source


   Development Centers

   -- Android Development Center
   -- Cloud Development Project Center
   -- HTML5 Development Center
   -- Windows Mobile Development Center