source: main/tags/2.41/gli/document.sh@ 30131

Last change on this file since 30131 was 5010, checked in by mdewsnip, 21 years ago

Minor changes to be more consistent with the Windows batch file. Now checks for javadoc before attempting to generate the documentation.

  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
File size: 2.4 KB
Line 
1#!/bin/sh
2
3
4## -------- Generate documentation for the Greenstone Librarian Interface --------
5
6## ---- Check Javadoc exists ----
7javadocpath=
8
9# Some users may set the above line manually
10if [ "$javadocpath" == "" ]; then
11
12 # If it is set, use the JAVAHOME environment variable
13 if [ "$JAVAHOME" != "" ]; then
14 javadocpath="$JAVAHOME/bin/javadoc"
15
16 # Check if Javadoc is on the search path
17 else
18 javadocpath=`which javadoc 2> /dev/null`
19 fi
20fi
21
22# Check that a Javadoc executable has been found
23echo "Checking Javadoc: $javadocpath"
24if [ ! -x "$javadocpath" ]; then
25 echo
26 echo "Failed to locate an appropriate version of Javadoc. You must install a"
27 echo "Java Development Kit (version 1.4 or greater) before generating the"
28 echo "documentation for the Greenstone Librarian Interface."
29 exit 1
30fi
31
32
33## ---- Document the GLI ----
34echo
35echo "Generating documentation for the Greenstone Librarian Interface..."
36
37javadoc -classpath classes/ -sourcepath src/ -source 1.4 -author -breakiterator -d docs/ -group "Gatherer v2.3" org.greenstone.gatherer:org.greenstone.gatherer.checklist:org.greenstone.gatherer.collection:org.greenstone.gatherer.file:org.greenstone.gatherer.gui:org.greenstone.gatherer.gui.browser:org.greenstone.gatherer.gui.combobox:org.greenstone.gatherer.gui.messages:org.greenstone.gatherer.gui.metaaudit:org.greenstone.gatherer.gui.table:org.greenstone.gatherer.gui.tree:org.greenstone.gatherer.help:org.greenstone.gatherer.sarm:org.greenstone.gatherer.shell:org.greenstone.gatherer.util -group "Collection Design Module" org.greenstone.gatherer.cdm:org.greenstone.gatherer.cdm.custom -group "Metadata Set Manager" org.greenstone.gatherer.msm:org.greenstone.gatherer.msm.parsers -group "Value Tree Controls" org.greenstone.gatherer.valuetree -private -splitindex -version org.greenstone.gatherer org.greenstone.gatherer.checklist org.greenstone.gatherer.collection org.greenstone.gatherer.file org.greenstone.gatherer.gui org.greenstone.gatherer.gui.browser org.greenstone.gatherer.gui.combobox org.greenstone.gatherer.gui.messages org.greenstone.gatherer.gui.metaaudit org.greenstone.gatherer.gui.table org.greenstone.gatherer.gui.tree org.greenstone.gatherer.help org.greenstone.gatherer.sarm org.greenstone.gatherer.shell org.greenstone.gatherer.util org.greenstone.gatherer.cdm org.greenstone.gatherer.cdm.custom org.greenstone.gatherer.msm org.greenstone.gatherer.msm.parsers org.greenstone.gatherer.valuetree
38
39echo "Done!"
Note: See TracBrowser for help on using the repository browser.