Added "make html" target to build doxygen documentation in docs/api/html.

git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid@483600 13f79535-47bb-0310-9956-ffa450edef68

5 files changed, 50 insertions, 8 deletions

diff --git a/cpp/Makefile.am b/cpp/Makefile.am
index 2dc0c22b08..644b1519dc 100644
--- a/cpp/Makefile.am
+++ b/cpp/Makefile.am
@@ -1,10 +1,11 @@
 AUTOMAKE_OPTIONS = 1.9.2 foreign
 ACLOCAL_AMFLAGS = -I m4
 
-EXTRA_DIST = DESIGN LICENSE.txt NOTICE.txt README.rhel3
+EXTRA_DIST = README-dist DESIGN LICENSE.txt NOTICE.txt README.rhel3
 
-SUBDIRS = gen lib tests src
+SUBDIRS = gen lib tests src docs/api
 
 # Update libtool, if needed.
 libtool: $(LIBTOOL_DEPS)
 	$(SHELL) ./config.status --recheck
+
diff --git a/cpp/README-dev b/cpp/README-dev
index 0bad4ec8d5..c39dcc613a 100644
--- a/cpp/README-dev
+++ b/cpp/README-dev
@@ -8,13 +8,17 @@ As per README-dist plus:
  * libtool 1.5: http://www.gnu.org/software/libtool
  * CppUnit 1.10.2: http://cppunit.sourceforge.net
 
-Optional: to generate documentation from source code comments you need:
+Optional: to re-generated generated code from the XML specification:
+ * java 5
+
+Optional: to generate documentation you need:
  * doxygen 1.4.6: http://sourceforge.net/projects/doxygen/
  * graphviz 2.8: http://www.graphviz.org/
+ * help2man 1.36: http://www.gnu.org/software/help2man/
 
 If you use yum to install packages, do the command from the README-dist then:
 
-# yum install apr-devel cppunit-devel boost-devel doxygen graphviz
+# yum install doxygen graphviz
 
 == Recent changes ==
 
diff --git a/cpp/README-dist b/cpp/README-dist
index 133eb7da81..febdd7c3b3 100644
--- a/cpp/README-dist
+++ b/cpp/README-dist
@@ -11,7 +11,7 @@ Optional: if you want to run the qpid unit tests:
  
 If you use yum to install packages you can do:
 
-  # yum install apr boost
+  # yum install apr apr-devel boost boost-devel cppunit cppunit-devel
 
 == Building ==
 
diff --git a/cpp/doxygen.cfg b/cpp/docs/api/Doxyfile
index 0fcec07785..4e8afcad60 100644
--- a/cpp/doxygen.cfg
+++ b/cpp/docs/api/Doxyfile
@@ -32,7 +32,7 @@ PROJECT_NUMBER         = 0
 # 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       = build
+OUTPUT_DIRECTORY       = .
 
 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 
 # 4096 sub-directories (in 2 levels) under the output directory of each output 
@@ -461,7 +461,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT      		= src build/gen
+INPUT      		= ../../lib/common ../../lib/client ../../gen
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
@@ -469,7 +469,7 @@ INPUT      		= src build/gen
 # blank the following patterns are tested: 
 
 
-FILE_PATTERNS          = *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py
+FILE_PATTERNS          = *.h
 
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories 
 # should be searched for input files as well. Possible values are YES and NO. 
diff --git a/cpp/docs/api/Makefile.am b/cpp/docs/api/Makefile.am
new file mode 100644
index 0000000000..22a2efe8b3
--- /dev/null
+++ b/cpp/docs/api/Makefile.am
@@ -0,0 +1,37 @@
+
+html: Doxyfile doxygen.tstamp
+
+# TODO aconway 2006-12-07: devdoc target to generate doc for all
+# headers, with private/protected functions.
+
+SOURCES = \
+  $(wildcard $(topsrcdir)/gen/*.h) \
+  $(wildcard $(topsrcdir)/lib/common/*.h) \
+  $(wildcard $(topsrcdir)/lib/common/sys/*.h) \
+  $(wildcard $(topsrcdir)/lib/common/framing/*.h) \
+  $(wildcard $(topsrcdir)/lib/client/*.h) 
+
+doxygen.tstamp: $(SOURCES)
+	doxygen
+	touch $@
+
+clean-local:
+	rm -rf docs.tstamp html man latex doxygen.tstamp xml
+
+HTML_TARGET_DIR=$(pkgdatadir)/api/html
+
+install-data-local:
+	installfiles=`echo html/*`; \
+	if test "$$installfiles" = 'html/*'; \
+	then echo '-- Nothing to install' ; \
+	else \
+		$(mkinstalldirs) $(DESTDIR)$(HTML_TARGET_DIR); \
+		for i in $$installfiles; do \
+			echo '-- Installing '$$i ; \
+			$(INSTALL_DATA) $$i $(DESTDIR)$(HTML_TARGET_DIR); \
+		done; \
+	fi
+
+uninstall-local:
+	rm -f $(DESTDIR)$(HTML_TARGET_DIR)/*
+