Re: generate new visad api docs

• To: Eugene Teh <teh@xxxxxxxxxxxxxxxxxxxx>
• Subject: Re: generate new visad api docs
• From: Dave Glowacki <dglo@xxxxxxxxxxxxx>
• Date: Wed, 02 Sep 1998 14:34:02 -0500

>       The visad api docs on the website is out-of-date. 
>       Can someone please generate a new one?

Done.

>       Also - how can I do that myself ?

I've appended the Makefile rules I used to generate the current
documentation. The JDK1.2beta4 version of javadoc chokes on empty
directories (and thus the commented-out section doesn't work) so
I had to enumerate all the subdirectories in the VisAD distribution
via SUBDIRS macro.  If javadoc is ever fixed, I'll add the 'javadoc'
rule to the Makefile.

##########################################################################

JAVADOC = javadoc -J-Xmx64m

#javadoc:
#       @if [ ! -d $(DOCDIR) ]; then mkdir $(DOCDIR); fi
#       THISDIR=`pwd`;                                                  \
#       TOPDIR=`cd ..; pwd`;                                            \
#       $(JAVADOC) -d $$THISDIR/$(DOCDIR) -sourcepath $$TOPDIR          \
#                       `find $$THISDIR -name docs -prune -o            \
#                               -name CVS -prune -o -type d -print |    \
#                       sed -e "s;^$$TOPDIR/;;" -e 's;/;.;g'`

SUBDIRS = \
        nom/tam/util                    \
        nom/tam/fits                    \
        nom/tam/test                    \
        visad/data/fits                 \
        visad/data/gif                  \
        visad/data/hdfeos/hdfeosc       \
        visad/data/hdfeos               \
        visad/data/netcdf/in            \
        visad/data/netcdf/out           \
        visad/data/netcdf/units         \
        visad/data/netcdf               \
        visad/data/vis5d                \
        visad/data                      \
        visad/examples                  \
        visad/java2d                    \
        visad/java3d                    \
        visad/meteorology               \
        visad/ss                        \
        visad/util                      \
        visad

javadoc:
        @if [ ! -d $(DOCDIR) ]; then mkdir $(DOCDIR); fi
        THISDIR=`pwd`;                                                  \
        TOPDIR=`cd ..; pwd`;                                            \
        $(JAVADOC) -d $$THISDIR/$(DOCDIR) -sourcepath $$TOPDIR          \
                        `echo ${SUBDIRS} | sed -e 's;/;.;g'`

• References:
  • generate new visad api docs
    • From: Eugene Teh