#!/bin/csh -v
# File: CreateMAExplorerJavaDocs.do
#
# Scripts to make Open Java API class docs for MAExplorer at various levels of resolution
#
# Peter Lemkin, LECB, RDC, Frederick, MD 21702
#
#  $Date: 2002/6/04 14:19:06$ 
#
# Note: the script assumes that the directories used in this script exist and have
# data in them.
#

# 1. This is ALL files including MAExplorer+MAEPlugins (public and private).
javadoc -author -version -private -splitindex -use -d ../MAExplorer/docs/docsFull \
   ../MAExplorer/*.java \
   ../MAExplorer/MAEPlugin \
   ../MAExplorer/MAEPlugin.analysis ../MAExplorer/MAEPlugin.connection \
   ../MAExplorer/MAEPlugin.popup



# 2. This is ALL files including MAExplorer+MAEPlugins but no private.
javadoc -author -version -splitindex -use -d ../MAExplorer/docs/docsAllPublic \
   ../MAExplorer/*.java \
   ../MAExplorer/MAEPlugin \
   ../MAExplorer/MAEPlugin.analysis ../MAExplorer/MAEPlugin.connection \
   ../MAExplorer/MAEPlugin.popup


# 3. This is OpenJavaAPI files including MAExplorer+MAEPlugins but no private.
javadoc -author -version -splitindex -use -d ../MAEPlugins/docsOJAPI \
   ../MAExplorer/MAExplorer.java ../MAExplorer/MaeJavaAPI.java \
   ../MAExplorer/MJA*.java ../MAExplorer/SimpleTable.java \
   ../MAExplorer/WriteGifEncoder.java \
   ../MAExplorer/MAEPlugin \
   ../MAExplorer/MAEPlugin.analysis ../MAExplorer/MAEPlugin.connection \
   ../MAExplorer/MAEPlugin.popup


# 4. This is OpenJavaAPI files including MAExplorer+MAEPlugins but no private.
javadoc -author -version -splitindex -use -d ../MAEPlugins/docsMJA \
   ../MAExplorer/MAExplorer.java ../MAExplorer/MaeJavaAPI.java \
   ../MAExplorer/MJA*.java ../MAExplorer/SimpleTable.java \
   ../MAExplorer/WriteGifEncoder.java


# ---------------------------------------------------------------------
#
#  Description of the four levels of documentation
#  ===============================================
#
# 1. /docsFull - is ALL public and private methods and data
#    in ALL files including:
#      (MAExplorer/*.java + MAEPlugins/*.java MAEPlugin.analysis/*.java+
#       MAEPlugin.connection/*.java + MAEPlugin.popup/*.java).
# NOTE: This is useful only if you have the entire source code tree.
#
#
# 2. /docsAllPublic - is ALL public methods and data in ALL files
#    including:
#      (MAExplorer/*.java + MAEPlugins/*.java MAEPlugin.analysis/*.java+
#       MAEPlugin.connection/*.java + MAEPlugin.popup/*.java).
# NOTE: This is what the MAEplugin writer would actually see if they mounted the
# MAExplorer.jar file in a IDE such as Forte when developing a new plugin.
#
#
# 3. /docsOJAPI - is ALL public Open Java API files including:
#      (MAEPlugins/*.java + MJAxxx/*.java + MaeJavaAPI.java + MAExplorer.java
#       SimpleTable.java + WriteGifEncoder.java).
#
# NOTE: This is useful for viewing the complete OpenJavaAPI library available to
# the plugin writer.
#
#
# 4. /docsMJA - is the MaeJavaAPI subset of files from the Open Java
#    API that includes:
#      (MAExplorer.java + MaeJavaAPI.java + MJA*.java +
#       SimpleTable.java + WriteGifEncoder.java).
# NOTE: This is useful for viewing just the MJAxxx library that they would use 
# for doing most interaction with MAExplorer.
#
#
# To view the documentation, access the Java docs by opening one of these 
# MaeJavaDocs/docs*/index.html files with a HTML Web browser.
# ---------------------------------------------------------------------