diff options
| author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2020-11-20 04:29:01 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-20 04:29:01 (GMT) |
| commit | c421ecca2c0b662bedee45484fd2bff774413dc2 (patch) | |
| tree | 20dbc79def9c42755a2992a2efa32927ab1b073a /release_docs | |
| parent | 6ab961488afdd27c9f1ab907d557e7406a0e01f9 (diff) | |
| download | hdf5-c421ecca2c0b662bedee45484fd2bff774413dc2.zip hdf5-c421ecca2c0b662bedee45484fd2bff774413dc2.tar.gz hdf5-c421ecca2c0b662bedee45484fd2bff774413dc2.tar.bz2 | |
Add doxygen framework for CMake and autotools (#90)
Diffstat (limited to 'release_docs')
| -rw-r--r-- | release_docs/INSTALL_CMake.txt | 1 | ||||
| -rw-r--r-- | release_docs/RELEASE.txt | 11 |
2 files changed, 12 insertions, 0 deletions
diff --git a/release_docs/INSTALL_CMake.txt b/release_docs/INSTALL_CMake.txt index 8ebfa84..68be3a4 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 bb307b2..bb31fc8 100644 --- a/release_docs/RELEASE.txt +++ b/release_docs/RELEASE.txt @@ -47,6 +47,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 |