[PATCH] master: Doxygen generation broken

[Tim Landscheidt]

Hi,

the transition from recursive makefiles to the present ones
broke Doxygen generation.  The first attached patch fixes
this.

  Then running Doxygen 1.6.1 gave some warnings about obso-
lete options in Doxyfile that don't seem to be important.
Also, Doxygen complained about not being able to find header
files.  First I thought that these were gnulib's, so I added
lib to the INCLUDE_PATH, but Doxygen kept complaining even
about system header files like stddef.h included with angle
brackets, so I ignored it.

  Finally, it revealed a small typo in a Doxygen comment in
src/InadequacyList.h which the other attached patch fixes.

Tim

>From 0e238be8a5f7807a684edd658ed3c962336a29e5 Mon Sep 17 00:00:00 2001
From: Tim Landscheidt <address@hidden>
Date: Tue, 27 Mar 2012 19:28:02 +0000
Subject: [PATCH 1/2] Fix Doxygen generation and clean-up.

* doc/Doxyfile.in: Amend OUTPUT_DIRECTORY.
* doc/local.mk (html-local): Amend working directory.
(CLEANDIRS): Fix "html", remove "latex".
---
 doc/Doxyfile.in |    2 +-
 doc/local.mk    |    4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index b813d80..1fa2e2b 100644
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -30,7 +30,7 @@ PROJECT_NUMBER         = "@PACKAGE_VERSION@"
 # If a relative path is entered, it will be relative to the location
 # where doxygen was started. If left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       = .
+OUTPUT_DIRECTORY       = @top_builddir@/doc
 
 # The OUTPUT_LANGUAGE tag is used to specify the language in which all
 # documentation generated by doxygen is written. Doxygen will use this
diff --git a/doc/local.mk b/doc/local.mk
index 09c387a..c4a9e52 100644
--- a/doc/local.mk
+++ b/doc/local.mk
@@ -124,7 +124,7 @@ DOXYGEN = doxygen
 doc: html
 
 html-local: doc/Doxyfile
-       $(AM_V_GEN) cd doc && $(DOXYGEN)
+       $(AM_V_GEN) $(DOXYGEN) $<
 
 edit = sed -e 's,@PACKAGE_NAME\@,$(PACKAGE_NAME),g' \
           -e 's,@PACKAGE_VERSION\@,$(PACKAGE_VERSION),g' \
@@ -138,4 +138,4 @@ CLEANFILES += doc/Doxyfile
 doc/Doxyfile: $(top_srcdir)/doc/Doxyfile.in
        $(AM_V_GEN) $(edit) $(top_srcdir)/doc/Doxyfile.in >doc/Doxyfile
 
-CLEANDIRS += html latex
+CLEANDIRS += doc/html
-- 
1.6.2.5

>From 8fce5b90b8591b364eaef2be68cf62c8c627bf3d Mon Sep 17 00:00:00 2001
From: Tim Landscheidt <address@hidden>
Date: Tue, 27 Mar 2012 19:40:36 +0000
Subject: [PATCH 2/2] Fix Doxygen comment.

* src/InadequacyList.h: s#</t>#</tt>#.
---
 src/InadequacyList.h |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

diff --git a/src/InadequacyList.h b/src/InadequacyList.h
index d8120dd..0d00c5c 100644
--- a/src/InadequacyList.h
+++ b/src/InadequacyList.h
@@ -90,7 +90,7 @@ typedef struct InadequacyList {
  *     <tt>manifesting_state->reductions->num + 1</tt>.
  *   - If the set of all \c InadequacyList nodes with which the new
  *     \c InadequacyList node might be compared is currently empty, then
- *     it is best if <tt>*node_count</t> is zero so that the node count
+ *     it is best if <tt>*node_count</tt> is zero so that the node count
  *     does not eventually overflow.  However, if that set is not
  *     currently empty, then <tt>*node_count</tt> has not been modified
  *     by any function except \c InadequacyList__new_conflict since the
-- 
1.6.2.5