Changeset 5006

Timestamp:

2003-07-23T11:26:05+12:00 (21 years ago)

Author:

mdewsnip

Message:

Now does its best to find javadoc before generating documentation.

File:

• trunk/gli/document.bat (modified) (1 diff)

trunk/gli/document.bat

@@ -1 +1 @@
 @echo off
 
+
+::  -------- Generate documentation for the Greenstone Librarian Interface --------
+
+:findJavadoc
+:: ---- Check Javadoc exists ----
+set JAVADOCPATH=
+
+:: Some users may set the above line manually
+if not "%JAVADOCPATH%" == "" goto testJavadoc
+
+    :: If it is set, use the JAVAHOME environment variable
+    if not "%JAVAHOME%" == "" goto javahome
+
+    :: Check if Javadoc is on the search path
+    echo %PATH%| which javadoc.exe | setvar JAVADOCPATH > setjavadoc.bat
+    call setjavadoc.bat
+    del setjavadoc.bat
+    if not "%JAVADOCPATH%" == "" goto testJavadoc
+
+    :: Still haven't found anything, so try looking in the registry (gulp!)
+    regedit /E jdk.reg "HKEY_LOCAL_MACHINE\SOFTWARE\JavaSoft\Java Development Kit"
+    type jdk.reg > jdk.txt 2> nul
+    del jdk.reg 2> nul
+
+    findjava jdk.txt | setvar JAVADOCPATH > setjavadoc.bat
+    del jdk.txt 2> nul
+    call setjavadoc.bat
+    del setjavadoc.bat
+
+    :: If nothing was found in the registry, we're stuck
+    if "%JAVADOCPATH%" == "" goto noJavadoc
+
+    set JAVADOCPATH=%JAVADOCPATH%\bin
+    goto testJavadoc
+
+:javahome
+    set JAVADOCPATH=%JAVAHOME%\bin
+
+:testJavadoc
+:: Check that a Javadoc executable has been found
+echo Checking Javadoc: %JAVADOCPATH%
+if exist "%JAVADOCPATH%\javadoc.exe" goto docGLI
+
+:noJavadoc
+    echo.
+    echo Failed to locate an appropriate version of Javadoc. You must install a
+    echo Java Development Kit (version 1.4 or greater) before generating the
+    echo documentation for the Greenstone Librarian Interface.
+    goto exit
+
+
+:docGLI
+:: ---- Document the GLI ----
+echo.
 echo Generating documentation for the Greenstone Librarian Interface...
 
-javadoc -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 
+"%JAVADOCPATH%\javadoc.exe" -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 
 
-echo Done.
+echo Done!
+
+:exit
+echo.
+pause
+
+:: ---- Clean up ----
+set JAVADOCPATH=