Changeset 1397 for trunk

Timestamp:

Aug 6, 2008, 7:56:39 PM (13 years ago)

Author:

Peter

Message:

fixes #409

Location:

trunk

Files:

• README (modified) (1 diff)
• configure.ac (modified) (2 diffs)
• doc/Makefile.am (modified) (1 diff)

trunk/README

@@ -81 +81 @@
 
 [http://www.doxygen.org/ Doxygen] is required for generation of the
-API documentation
+API documentation. Doxygen uses a number of applications, epstopdf,
+latex, makeindex, and pdflatex. If any of these applications are
+missing, generation of API documentation is disabled.
 
 = Documentation =

trunk/configure.ac

@@ -59 +59 @@
 AC_PROG_INSTALL
 AC_PROG_SED
-AC_CHECK_PROG([HAVE_DOXYGEN], [doxygen], [true], [false])
-
-AM_CONDITIONAL(HAVE_DOXYGEN, test "$HAVE_DOXYGEN" = "true")
+
+AC_MSG_NOTICE([checking whether tools for generating documentation is available])
+have_dox_tools="yes"
+AC_PATH_PROG([DOXYGEN], [doxygen], [no])
+if test "$DOXYGEN" = "no"; then
+   AC_MSG_WARN([unable to find doxygen application])
+   have_dox_tools=no
+fi
+AC_CHECK_PROG([have_epstopdf], [epstopdf], [yes], [no])
+if test "$have_epstopdf" != "yes"; then
+   AC_MSG_WARN([unable to find epstopdf application])
+   have_dox_tools=no
+fi
+AC_CHECK_PROG([have_latex], [latex], [yes], [no])
+if test "$have_latex" != "yes"; then
+   AC_MSG_WARN([unable to find latex application])
+fi
+AC_CHECK_PROG([have_makeindex], [makeindex], [yes], [no])
+if test "$have_makeindex" != "yes"; then
+   AC_MSG_WARN([unable to find makeindex application])
+   have_dox_tools=no
+fi
+AC_CHECK_PROG([have_pdflatex], [pdflatex], [yes], [no])
+if test "$have_pdflatex" != "yes"; then
+   AC_MSG_WARN([unable to find pdflatex application])
+   have_dox_tools=no
+fi
+
+AM_CONDITIONAL(HAVE_DOXYGEN, test "$have_dox_tools" = "yes")
 AC_CONFIG_FILES([test/documentation_test.sh], 
                 [chmod +x test/documentation_test.sh])
@@ -229 +255 @@
 
 # warning about missing doxygen
-if (test "$HAVE_DOXYGEN" != "true") ; then
-  AC_MSG_WARN([
-  Doxygen was not found. Yat will compile and work without doxygen.
-  However, in order to enable generation of documentation, please
-  install Doxygen available at http://www.doxygen.org/
+if (test "$HAVE_DOX_TOOLS" != "yes") ; then
+  AC_MSG_WARN([
+  Some pre-requisites for generating documentation were not
+  fulfilled. The build will not create any documentation.
+  Please consult the 'README' file for more information about
+  what is needed to generate documentation and refer to above
+  warning messages.
   ])
 fi

trunk/doc/Makefile.am

@@ -69 +69 @@
 
 $(DX_HTML_OUTPUT)/index.html: Makefile doxygen.config stamp-doxygen
-  @(cat doxygen.config; $(ECHO) GENERATE_HTML = YES) | doxygen -;
+  @(cat doxygen.config; $(ECHO) GENERATE_HTML = YES) | $(DOXYGEN) -;
 
 $(DX_LATEX_OUTPUT)/refman.tex: Makefile doxygen.config stamp-doxygen
-  @(cat doxygen.config; $(ECHO) GENERATE_LATEX = YES) | doxygen -;
+  @(cat doxygen.config; $(ECHO) GENERATE_LATEX = YES) | $(DOXYGEN) -;
 
 $(PACKAGE).dvi: $(DX_LATEX_OUTPUT)/refman.tex