Merge pull request #89 from byrnHDF/hdf5_1_12

Hdf5 1 12 doxygen support framework

2 files changed, 47 insertions, 3 deletions

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 597f620..38225e9 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -1356,3 +1356,41 @@ if (NOT WIN32)
       COMPONENT libraries
   )
 endif ()
+
+#-----------------------------------------------------------------------------
+# Option to build documentation
+#-----------------------------------------------------------------------------
+if (DOXYGEN_FOUND)
+  set (DOXYGEN_PACKAGE ${HDF5_PACKAGE})
+  set (DOXYGEN_VERSION_STRING ${HDF5_VERSION_STRING})
+  set (DOXYGEN_INCLUDE_ALIASES ${HDF5_DOXYGEN_DIR}/aliases)
+  set (DOXYGEN_PROJECT_LOGO ${HDF5_DOXYGEN_DIR}/img/HDFG-logo.png)
+  set (DOXYGEN_PROJECT_BRIEF "C-API Reference")
+  set (DOXYGEN_INPUT_DIRECTORY ${HDF5_SRC_DIR} ${HDF5_DOXYGEN_DIR}/dox ${HDF5_GENERATED_SOURCE_DIR}/shared)
+  set (DOXYGEN_OPTIMIZE_OUTPUT_FOR_C YES)
+  set (DOXYGEN_MACRO_EXPANSION YES)
+  set (DOXYGEN_OUTPUT_DIRECTORY ${HDF5_BINARY_DIR}/hdf5lib_docs)
+
+  # Replace variables inside @@ with the current values
+  configure_file(${HDF5_DOXYGEN_DIR}/Doxyfile.in Doxyfile @ONLY)
+
+  doxygen_add_docs(hdf5lib_doc
+#      ${common_SRCS} ${shared_gen_SRCS} ${H5_PUBLIC_HEADERS} ${H5_PRIVATE_HEADERS} ${H5_GENERATED_HEADERS} ${HDF5_DOXYGEN_DIR}/dox
+      ${DOXYGEN_INPUT_DIRECTORY}
+      ALL
+      WORKING_DIRECTORY ${HDF5_SRC_DIR}
+      COMMENT "Generating HDF5 library Source Documentation"
+  )
+  install(
+      DIRECTORY ${HDF5_BINARY_DIR}/hdf5lib_docs/html
+      DESTINATION ${HDF5_INSTALL_DATA_DIR}
+      COMPONENT Documents
+  )
+
+  if(NOT TARGET doxygen)
+    add_custom_target(doxygen)
+  endif()
+
+  add_dependencies(doxygen hdf5lib_doc)
+
+endif ()
diff --git a/src/Makefile.am b/src/Makefile.am
index cbecccd..118c0a3 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -19,6 +19,8 @@
 include $(top_srcdir)/config/commence.am
 include $(top_srcdir)/config/lt_vers.am
 
+# include Doxygen rules (requires autoconf-archive >2016-03-20)
+@DX_RULES@
 
 # How to build H5detect for number format detection.
 # Use -g to force no optimization since many compilers (e.g., Intel) takes
@@ -33,13 +35,13 @@ lib_LTLIBRARIES=libhdf5.la
 libhdf5_la_LDFLAGS= -version-info $(LT_VERS_INTERFACE):$(LT_VERS_REVISION):$(LT_VERS_AGE) $(AM_LDFLAGS)
 
 # H5Tinit.c and H5lib_settings.c are generated files and should be cleaned.
-MOSTLYCLEANFILES=H5Tinit.c H5lib_settings.c
+MOSTLYCLEANFILES=H5Tinit.c H5lib_settings.c $(DX_CLEANFILES)
 # H5pubconf.h is generated by configure, and should be cleaned.
 DISTCLEANFILES=H5pubconf.h
 
 # library sources
 libhdf5_la_SOURCES= H5.c H5checksum.c H5dbg.c H5lib_settings.c H5system.c \
-	H5timer.c H5trace.c \
+		H5timer.c H5trace.c \
         H5A.c H5Abtree2.c H5Adense.c H5Adeprec.c H5Aint.c H5Atest.c \
         H5AC.c H5ACdbg.c H5ACproxy_entry.c \
         H5B.c H5Bcache.c H5Bdbg.c \
@@ -196,12 +198,16 @@ $(top_srcdir)/src/H5version.h: $(top_srcdir)/src/H5vers.txt
 $(top_srcdir)/src/H5overflow.h: $(top_srcdir)/src/H5overflow.txt
 	perl $(top_srcdir)/bin/make_overflow $?
 
+# doxygen support
+if BUILD_DOXYGEN_CONDITIONAL
+doxygen: doxygen-doc
+endif
+
 # Add TRACE macros to library source files.  This is done via the trace script
 # in the hdf5/bin directory.  If the file contains HDF5 API macros, a "clean"
 # version of the source file is saved with a tilde (~) after its name and
 # tracing information is inserted.  trace should have no effect on files
 # without HDF5 macros.
-.PHONY: trace
 
 trace: $(libhdf5_la_SOURCES)
 	@for dep in $? dummy; do                                          \