Re: VisAD JavaDoc

• To: m huang <qomo@xxxxxxxxx>
• Subject: Re: VisAD JavaDoc
• From: "Stephen C. Upton" <upton@xxxxxxxxx>
• Date: Mon, 25 Nov 2002 09:22:13 -0500

Hi M Huang,

You can put all of the package names in a file - one package name per
line - and then call javadoc with that file name as one of the options.
Here's the info from the docs:
Example - Two Arg Files

    You can create two argument files -- one for the Javadoc options and
the other for the package names or source filenames:
    (Notice the following lists have no line-continuation characters.)

    Create a file named "options" containing:

         -d docs-filelist
         -use
         -splitindex
         -windowtitle 'Java 2 Platform v1.3 API Specification'
         -doctitle 'Java<sup><font size="-2">TM</font></sup> 2 Platform
v1.4 API Specification'
         -header '<b>Java 2 Platform </b><br><font
size="-1">v1.4</font>'
         -bottom 'Copyright 1993-2000 Sun Microsystems, Inc. All Rights
Reserved.'
         -group "Core Packages" "java.*"
         -overview
\java\pubs\ws\1.3\src\share\classes\overview-core.html
         -sourcepath \java\pubs\ws\1.3\src\share\classes

    Create a file named "packages" containing:

         com.mypackage1
         com.mypackage2
         com.mypackage3

    You would then run javadoc with:

      C:> javadoc @options @packages

Can't help with the other problem. :-(

HTH
steve

m huang wrote:

> Hi Dave,
>
> Thanks for fixing the on-line javaDocs.
>
> The "broken link" problem is still there. For example
> in visad.DisplayRealType page, if I click on visad.ScalarType
> I get a ``Not Found <br> The requested
> URL /+AH4-dglo/visad/visad/ScalarType.html was not found on this
> server.''
>
> If I open a link in a new window, I get HTTP 404. Now this is
> the strange part: if I click on the address box in this browser
> window and press <return>, effectively type in the address,
> the page can be displayed fine! I updated my IE with no
> improve. From what I have found out, not all IE's have this
> problem. Netscape doesn't have this problem. I believe it has
> something to do with M$ IE being finicky.
>
> More about VisAD JavaDoc, I created my own version of JavaDoc
> from the source jar file,  and find most packages
> have the package.html file missing, at least not in the source
> file jar. Only these ones have packages.html:
> HTTPClient
> visad.bio, visad.browser
> visad.data.dods
> visad.data.in
>
> I cut-and-paste package name list from on-line javaDoc,
> and made this to generate local JavaDoc: (all in one line.
> Is there a better way to do this?):
>
> javadoc -J-Xmx256m -d doc-files dods.dap dods.dap.parser
> dods.dap.Server dods.util edu.wisc.ssec.mcidas
> edu.wisc.ssec.mcidas.adde gnu.regexp HTTPClient ij ij.gui ij.io
> ij.measure ij.plugin ij.plugin.filter ij.plugin.frame ij.process
> ij.text ij.util ncsa.hdf.hdf5lib ncsa.hdf.hdf5lib.exceptions
> nom.tam.fits nom.tam.test nom.tam.util ucar.multiarray ucar.netcdf
> ucar.tests ucar.util visad visad.aeri visad.aune visad.benjamin
> visad.bio visad.bom visad.browser visad.cluster visad.collab
> visad.data visad.data.amanda visad.data.biorad visad.data.dods
> visad.data.fits visad.data.gif visad.data.hdf5
> visad.data.hdf5.hdf5objects visad.data.hdfeos
> visad.data.hdfeos.hdfeosc visad.data.in visad.data.jai
> visad.data.mcidas visad.data.netcdf visad.data.netcdf.in
> visad.data.netcdf.out visad.data.netcdf.units visad.data.qt
> visad.data.text visad.data.tiff visad.data.units visad.data.vis5d
> visad.data.visad visad.data.visad.object visad.formula visad.georef
> visad.install visad.java2d visad.java3d visad.jmet visad.math
> visad.matrix visad.meteorology visad.paoloa visad.paoloa.spline
> visad.python visad.rabin visad.ss visad.util
>
> __________________________________________________
> Do you Yahoo!?
> Yahoo! Mail Plus ? Powerful. Affordable. Sign up now.
> http://mailplus.yahoo.com

• References:
  • Re: VisAD JavaDoc
    • From: m huang