[Boost-commit] svn:boost r45852 - branches/CMake/release/tools/build/CMake

From: dgregor_at_[hidden]
Date: 2008-05-27 23:13:48

Author: dgregor
Date: 2008-05-27 23:13:48 EDT (Tue, 27 May 2008)
New Revision: 45852
URL: http://svn.boost.org/trac/boost/changeset/45852

Log:
Document some of the new Boost documentation macros
Text files modified: 
   branches/CMake/release/tools/build/CMake/BoostDocs.cmake |    22 +++++++++++++++++++++-                  
   1 files changed, 21 insertions(+), 1 deletions(-)

Modified: branches/CMake/release/tools/build/CMake/BoostDocs.cmake
==============================================================================
--- branches/CMake/release/tools/build/CMake/BoostDocs.cmake	(original)
+++ branches/CMake/release/tools/build/CMake/BoostDocs.cmake	2008-05-27 23:13:48 EDT (Tue, 27 May 2008)
@@ -123,6 +123,24 @@
 endmacro(xsl_transform)
 
 # Use Doxygen to parse header files and produce BoostBook output.
+#
+#   doxygen_to_boostbook(output header1 header2 ...
+#     [PARAMETERS param1=value1 param2=value2 ... ])
+#
+# This macro sets up rules to transform a set of C/C++ header files
+# into BoostBook reference documentation. The resulting BoostBook XML
+# file will be named by the "output" parameter, and the set of headers
+# is provided following the output file. The actual parsing of header
+# files is provided by Doxygen, and is transformed into XML through
+# various XSLT transformations.
+#
+# Doxygen has a variety of configuration parameters. One can supply
+# extra Doxygen configuration parameters by providing NAME=VALUE pairs
+# following the PARAMETERS argument. These parameters will be added to
+# the Doxygen configuration file.
+#
+# This macro is intended to be used internally by
+# boost_add_documentation.
 macro(doxygen_to_boostbook OUTPUT)
   parse_arguments(THIS_DOXY
     "PARAMETERS"
@@ -433,7 +451,7 @@
 # Try to find Doxygen
 find_package(Doxygen)
 
-if (XSLTPROC)
+if (XSLTPROC AND DOXYGEN)
   if (DOCBOOK_DTD_DIR AND DOCBOOK_XSL_DIR)
     # Documentation build options
     option(BUILD_DOCUMENTATION "Whether to build library documentation" ON)
@@ -469,6 +487,8 @@
   set(BUILD_DOCUMENTATION_OKAY TRUE)
   if (NOT XSLTPROC)
     set(BUILD_DOCUMENTATION_OKAY FALSE)
+  elseif (NOT DOXYGEN)
+    set(BUILD_DOCUMENTATION_OKAY FALSE)
   elseif (NOT DOCBOOK_DTD_DIR)
     set(BUILD_DOCUMENTATION_OKAY FALSE)
   elseif (NOT DOCBOOK_XSL_DIR)