From: Justin Seyster <jseyster@cs.sunysb.edu>
Date: Wed, 16 Mar 2011 01:12:17 +0000 (-0400)
Subject: Doxygen now compiles docs when the build dir is not the src dir.
X-Git-Tag: release-v1.1~12
X-Git-Url: https://git.fsl.cs.stonybrook.edu/?a=commitdiff_plain;h=1c39f6e2a27fdb51022cf2670dd1cbcbed24d999;p=interaspect.git

Doxygen now compiles docs when the build dir is not the src dir.
---

diff --git a/Doxyfile b/Doxyfile
index a6d9b5c..cfd97fe 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -114,7 +114,7 @@ FULL_PATH_NAMES        = YES
 # If left blank the directory from which doxygen is run is used as the
 # path to strip.
 
-STRIP_FROM_PATH        =
+STRIP_FROM_PATH        = $(SRCDIR_SLASH)
 
 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
 # the path mentioned in the documentation of a class, which tells
@@ -123,7 +123,7 @@ STRIP_FROM_PATH        =
 # definition is used. Otherwise one should specify the include paths that
 # are normally passed to the compiler using the -I flag.
 
-STRIP_FROM_INC_PATH    =
+STRIP_FROM_INC_PATH    = $(SRCDIR_SLASH)
 
 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter
 # (but less readable) file names. This can be useful is your file systems
@@ -568,7 +568,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = src
+INPUT                  = $(SRCDIR_SLASH)src
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -625,7 +625,7 @@ EXCLUDE_SYMBOLS        = aop_argkind
 # directories that contain example code fragments that are included (see
 # the \include command).
 
-EXAMPLE_PATH           = workspace
+EXAMPLE_PATH           = $(SRCDIR_SLASH)workspace
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp
@@ -779,13 +779,13 @@ HTML_FILE_EXTENSION    = .html
 # each generated HTML page. If it is left blank doxygen will generate a
 # standard header.
 
-HTML_HEADER            = web/doxy-header.html
+HTML_HEADER            = $(SRCDIR_SLASH)web/doxy-header.html
 
 # The HTML_FOOTER tag can be used to specify a personal HTML footer for
 # each generated HTML page. If it is left blank doxygen will generate a
 # standard footer.
 
-HTML_FOOTER            = web/doxy-footer.html
+HTML_FOOTER            = $(SRCDIR_SLASH)web/doxy-footer.html
 
 # The HTML_STYLESHEET tag can be used to specify a user-defined cascading
 # style sheet that is used by each HTML page. It can be used to
@@ -794,7 +794,7 @@ HTML_FOOTER            = web/doxy-footer.html
 # the style sheet file to the HTML output directory, so don't put your own
 # stylesheet in the HTML output directory as well, or it will be erased!
 
-HTML_STYLESHEET        = web/doxygen.css
+HTML_STYLESHEET        = $(SRCDIR_SLASH)web/doxygen.css
 
 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes,
 # files or namespaces will be aligned in HTML using tables. If set to
diff --git a/INSTALL b/INSTALL
index da5940e..dc7e35a 100644
--- a/INSTALL
+++ b/INSTALL
@@ -143,6 +143,26 @@ normally:
 # debugging support for the InterAspect library.
 make CFLAGS='-g -O0'
 
+---
+(3a. Documentation)
+-
+
+InterAspect's public API functions are all documented with Doxygen
+comments.  You can generate HTML documentation from these comments
+with the command:
+
+make doxygen-doc
+
+If you haven't configured InterAspect, you can still generate the
+documentation by just running:
+
+doxygen
+
+The documentation for the most recent InterAspect release is available
+at the InterAspect web site:
+
+http://www.fsl.cs.sunysb.edu/interaspect/
+
 --------
 4. Building an InterAspect Plug-in
 ---
diff --git a/README b/README
index b557cb0..64937c7 100644
--- a/README
+++ b/README
@@ -7,7 +7,7 @@ Important files and directories:
 
   - AUTHORS: The people to contact if you need help or if you have
     feedback.
-  - docs/html/: Extensive documentation for the InterAspect API.  You
+  - doc/html/: Extensive documentation for the InterAspect API.  You
     may need to run the command
 
     doxygen
diff --git a/configure.in b/configure.in
index 29f33b9..b43ad11 100644
--- a/configure.in
+++ b/configure.in
@@ -39,6 +39,13 @@ DX_PDF_FEATURE(OFF)
 DX_PS_FEATURE(OFF)
 DX_INIT_DOXYGEN([$PACKAGE_NAME],[Doxyfile],[doc])
 
+# HACK: We want to give the Doxygen config file the source directory
+# as an environment variable that definitely has a slash at the end.
+# That way, we can specify a file as $(SRCDIR_SLASH)filename.  If the
+# $(SRCDIR_SLASH) variable is not defined, the config file just uses
+# the current directory.
+DX_ENV_APPEND(SRCDIR_SLASH, $srcdir/)
+
 AC_CONFIG_FILES([Makefile
                  src/Makefile
 		 test/Makefile