summaryrefslogtreecommitdiffstats
path: root/release_docs
diff options
context:
space:
mode:
authorAllen Byrne <byrn@hdfgroup.org>2020-11-13 15:30:56 (GMT)
committerAllen Byrne <byrn@hdfgroup.org>2020-11-13 15:30:56 (GMT)
commit3e45af68d8f40e486d2fca1583056798b72dca91 (patch)
treee6937760637d5c45aa380f0da57b1f85fbe83c82 /release_docs
parent46bc76ab634ed418c51c4dc50741533027a9cec9 (diff)
downloadhdf5-3e45af68d8f40e486d2fca1583056798b72dca91.zip
hdf5-3e45af68d8f40e486d2fca1583056798b72dca91.tar.gz
hdf5-3e45af68d8f40e486d2fca1583056798b72dca91.tar.bz2
Add doxygen framework for CMake and autotools
Diffstat (limited to 'release_docs')
-rw-r--r--release_docs/INSTALL_CMake.txt1
-rw-r--r--release_docs/RELEASE.txt11
2 files changed, 12 insertions, 0 deletions
diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt
index 51e4016..f956104 100644
--- a/release_docs/INSTALL_CMake.txt
+++ b/release_docs/INSTALL_CMake.txt
@@ -791,6 +791,7 @@ if (HDF5_BUILD_FORTRAN)
if (BUILD_SHARED_LIBS AND NOT BUILD_STATIC_LIBS) default HDF5_INSTALL_MOD_FORTRAN is SHARED
if (NOT BUILD_SHARED_LIBS AND BUILD_STATIC_LIBS) default HDF5_INSTALL_MOD_FORTRAN is STATIC
if (NOT BUILD_SHARED_LIBS AND NOT BUILD_STATIC_LIBS) default HDF5_INSTALL_MOD_FORTRAN is SHARED
+HDF5_BUILD_DOC "Build documentation" OFF
HDF5_ENABLE_ANALYZER_TOOLS "enable the use of Clang tools" OFF
HDF5_ENABLE_SANITIZERS "execute the Clang sanitizer" OFF
HDF5_ENABLE_FORMATTERS "format source files" OFF
diff --git a/release_docs/RELEASE.txt b/release_docs/RELEASE.txt
index fbd5f18..2756c90 100644
--- a/release_docs/RELEASE.txt
+++ b/release_docs/RELEASE.txt
@@ -46,6 +46,17 @@ New Features
Configuration:
-------------
+ - Autotools and CMake target added to produce doxygen generated documentation
+
+ The default is OFF or disabled.
+ Autoconf option is '--enable-doxygen'
+ autotools make target is 'doxygen' and will build all doxygen targets
+ CMake configure option is 'HDF5_BUILD_DOC'.
+ CMake target is 'doxygen' for all available doxygen targets
+ CMake target is 'hdf5lib_doc' for the src subdirectory
+
+ (ADB - 2020/11/13)
+
- CMake option to use MSVC naming conventions with MinGW
HDF5_MSVC_NAMING_CONVENTION option enable to use MSVC naming conventions