mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-03-19 16:50:46 +08:00
Code Issues Packages Projects Releases Wiki Activity

Set doxygen default to normally disabled.

Browse Source
This commit is contained in:
Allen Byrne 2020-11-09 07:55:52 -06:00
parent 2457e58407
commit 4e6b6781ee
4 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CMakeLists.txt
View File

@ -535,7 +535,7 @@ endif ()
#-----------------------------------------------------------------------------
# Option to build documentation
#-----------------------------------------------------------------------------
option (HDF5_BUILD_DOC "Build documentation" ON)
option (HDF5_BUILD_DOC "Build documentation" OFF)
if (HDF5_BUILD_DOC AND EXISTS "${HDF5_DOXYGEN_DIR}" AND IS_DIRECTORY "${HDF5_DOXYGEN_DIR}")
# check if Doxygen is installed
find_package(Doxygen)

8
configure.ac
View File

@ -1055,14 +1055,14 @@ fi
## This needs to be exposed for the library info file.
AC_SUBST([HDF5_DOXYGEN])
## Default is to build DOXYGEN
HDF5_DOXYGEN=yes
## Default is to not build DOXYGEN
HDF5_DOXYGEN=no
AC_MSG_CHECKING([if building doxygen is disabled])
AC_MSG_CHECKING([if building doxygen is enabled])
AC_ARG_ENABLE([doxygen],
[AS_HELP_STRING([--enable-doxygen],
[Compile the HDF5 doxygen files [default=yes]])],
[Compile the HDF5 doxygen files [default=no]])],
[HDF5_DOXYGEN=$enableval])
if test "X$HDF5_DOXYGEN" = "Xyes"; then

2
release_docs/INSTALL_CMake.txt
View File

@ -791,7 +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" ON
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

1
release_docs/RELEASE.txt
View File

@ -50,6 +50,7 @@ New Features
-------------
- 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'.