diff options
| author | Dana Robinson <43805+derobins@users.noreply.github.com> | 2021-08-19 13:59:18 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-08-19 13:59:18 (GMT) |
| commit | 142c8515e7c84af692aee2281558fd58fcc6d587 (patch) | |
| tree | d285a721ac66762369420ab9abf32bc7c4e0b84d | |
| parent | 7e83e0574f43330e4b10b537267f7506b8d0ef20 (diff) | |
| download | hdf5-142c8515e7c84af692aee2281558fd58fcc6d587.zip hdf5-142c8515e7c84af692aee2281558fd58fcc6d587.tar.gz hdf5-142c8515e7c84af692aee2281558fd58fcc6d587.tar.bz2 | |
Brings doxygen changes from develop/1.12 for out-of-source builds (#936)
| -rw-r--r-- | Makefile.am | 16 | ||||
| -rw-r--r-- | release_docs/INSTALL | 13 | ||||
| -rw-r--r-- | src/Makefile.am | 8 |
3 files changed, 20 insertions, 17 deletions
diff --git a/Makefile.am b/Makefile.am index 3d7d923..fede167 100644 --- a/Makefile.am +++ b/Makefile.am @@ -35,6 +35,9 @@ include $(top_srcdir)/config/commence.am +# include Doxygen rules (requires autoconf-archive >2016-03-20) +@DX_RULES@ + # Define subdirectories to build. ## Automake understands that `make distclean' should recurse into ## conditional subdirectories even if `make all' does not. @@ -187,15 +190,10 @@ check-all-install: trace: @(cd src && $(MAKE) $(AM_MAKEFLAGS) $@) || exit 1; -# Run doxygen across source files. -# Currently, only invoke doxygen in the src directory. -doxygen: - @echo Invoking doxygen - for d in src; do \ - if test $$d != .; then \ - (cd $$d && $(MAKE) $(AM_MAKEFLAGS) $@) || exit 1; \ - fi; \ - done +# doxygen support +if BUILD_DOXYGEN_CONDITIONAL +doxygen: doxygen-doc +endif # Run tests with different Virtual File Drivers. # Currently, only invoke check-vfd in the test directory. diff --git a/release_docs/INSTALL b/release_docs/INSTALL index f523c85..d811efe 100644 --- a/release_docs/INSTALL +++ b/release_docs/INSTALL @@ -446,6 +446,19 @@ CONTENTS $ make -j -l6 +4.4. Building doxygen + One can optionally build the doxygen files for the HDF5 C library. + By default, this option is disabled. To build the html files, specify + '--enable-doxygen'. + + $ ./configure --enable-doxygen + + Configuration will halt if the required applications are not available. + To build: + + $ make doxygen + + 4.5. Testing HDF5 comes with various test suites, all of which can be run by specifying: diff --git a/src/Makefile.am b/src/Makefile.am index 00fb023..507c727 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -19,9 +19,6 @@ 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 # a long time to compile it with any optimization on. H5detect is used @@ -200,11 +197,6 @@ $(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 |