mirror of
https://github.com/HDFGroup/hdf5.git
synced 2025-03-31 17:10:47 +08:00
Doxygen add new files and update docs
This commit is contained in:
parent
4f7bb20a8f
commit
d6c92bde00
24
MANIFEST
24
MANIFEST
@ -193,6 +193,30 @@
|
||||
|
||||
./doc/code-conventions.md
|
||||
|
||||
./doxygen/aliases
|
||||
./doxygen/Doxyfile.in
|
||||
./doxygen/dox/H5Acreate.dox
|
||||
./doxygen/dox/H5Aiterate.dox
|
||||
./doxygen/dox/H5Fget_info.dox
|
||||
./doxygen/dox/H5Lget_info_by_idx.dox
|
||||
./doxygen/dox/H5Lget_info.dox
|
||||
./doxygen/dox/H5Literate_by_name.dox
|
||||
./doxygen/dox/H5Literate.dox
|
||||
./doxygen/dox/H5Lvisit_by_name.dox
|
||||
./doxygen/dox/H5Lvisit.dox
|
||||
./doxygen/dox/H5Oget_info_by_idx.dox
|
||||
./doxygen/dox/H5Oget_info_by_name.dox
|
||||
./doxygen/dox/H5Oget_info.dox
|
||||
./doxygen/dox/H5Ovisit_by_name.dox
|
||||
./doxygen/dox/H5Ovisit.dox
|
||||
./doxygen/dox/H5Sencode.dox
|
||||
./doxygen/dox/mainpage.dox
|
||||
./doxygen/dox/rm-template.dox
|
||||
./doxygen/examples/H5Fclose.c
|
||||
./doxygen/examples/H5Fcreate.c
|
||||
./doxygen/examples/hello_hdf5.c
|
||||
./doxygen/img/HDFG-logo.png
|
||||
|
||||
./examples/Attributes.txt
|
||||
./examples/Makefile.am
|
||||
./examples/h5_chunk_read.c
|
||||
|
@ -90,55 +90,3 @@ function(clang_format TARGET_NAME)
|
||||
endif()
|
||||
endfunction()
|
||||
|
||||
#
|
||||
# cmake-format
|
||||
#
|
||||
find_program(CMAKE_FORMAT_EXE "cmake-format")
|
||||
mark_as_advanced(FORCE CMAKE_FORMAT_EXE)
|
||||
if(CMAKE_FORMAT_EXE)
|
||||
message(STATUS "cmake-format found: ${CMAKE_FORMAT_EXE}")
|
||||
else()
|
||||
message(STATUS "cmake-format not found!")
|
||||
endif()
|
||||
|
||||
# When called, this function will call 'cmake-format' program on all listed
|
||||
# files (if both the program and the files exist and are found)
|
||||
# ~~~
|
||||
# Required:
|
||||
# TARGET_NAME - The name of the target to create.
|
||||
#
|
||||
# Optional:
|
||||
# ARGN - Any arguments passed in will be considered as 'files' to perform the
|
||||
# formatting on. Any items that are not files will be ignored. Both relative and
|
||||
# absolute paths are accepted.
|
||||
# ~~~
|
||||
function(cmake_format TARGET_NAME)
|
||||
if(CMAKE_FORMAT_EXE)
|
||||
set(FORMAT_FILES)
|
||||
# Determine files that exist
|
||||
foreach(iter IN LISTS ARGN)
|
||||
if(EXISTS ${iter})
|
||||
set(FORMAT_FILES ${FORMAT_FILES} ${iter})
|
||||
elseif(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/${iter})
|
||||
set(FORMAT_FILES ${FORMAT_FILES} ${CMAKE_CURRENT_SOURCE_DIR}/${iter})
|
||||
endif()
|
||||
endforeach()
|
||||
|
||||
# Generate target
|
||||
if(FORMAT_FILES)
|
||||
if(TARGET ${TARGET_NAME})
|
||||
message(
|
||||
ERROR
|
||||
"Cannot create cmake-format target '${TARGET_NAME}', already exists.")
|
||||
else()
|
||||
add_custom_target(${TARGET_NAME} COMMAND ${CMAKE_FORMAT_EXE} -i
|
||||
${FORMAT_FILES})
|
||||
|
||||
if(NOT TARGET cmake-format)
|
||||
add_custom_target(cmake-format)
|
||||
endif()
|
||||
add_dependencies(cmake-format ${TARGET_NAME})
|
||||
endif()
|
||||
endif()
|
||||
endif()
|
||||
endfunction()
|
||||
|
@ -791,6 +791,10 @@ 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_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
|
||||
|
||||
---------------- External Library Options ---------------------
|
||||
HDF5_ALLOW_EXTERNAL_SUPPORT "Allow External Library Building (NO GIT TGZ)" "NO"
|
||||
|
@ -48,13 +48,23 @@ New Features
|
||||
|
||||
Configuration:
|
||||
-------------
|
||||
- Autotools and CMake target added to produce doxygen generated documentation
|
||||
|
||||
Autoconf option is '--enable-doxygen'
|
||||
autotools make target is 'doxygen' and will build all doxygen targets
|
||||
CMake confgure option is 'HDF5_BUILD_DOC'.
|
||||
CMake target is 'doxygen' for all availble doxygen targets
|
||||
CMake target is 'hdf5lib_doc' for the src subdirectory
|
||||
|
||||
(ADB - 2020/11/03)
|
||||
|
||||
- CMake option to use MSVC naming conventions with MinGW
|
||||
|
||||
HDF5_MSVC_NAMING_CONVENTION option enable to use MSVC naming conventions
|
||||
when using a MinGW toolchain
|
||||
|
||||
(xan - 2020/10/30)
|
||||
|
||||
|
||||
- CMake option to statically link gcc libs with MinGW
|
||||
|
||||
HDF5_MINGW_STATIC_GCC_LIBS allows to statically link libg/libstdc++
|
||||
|
@ -1387,4 +1387,10 @@ if (DOXYGEN_FOUND)
|
||||
COMPONENT Documents
|
||||
)
|
||||
|
||||
if(NOT TARGET doxygen)
|
||||
add_custom_target(doxygen)
|
||||
endif()
|
||||
|
||||
add_dependencies(doxygen hdf5lib_doc)
|
||||
|
||||
endif ()
|
||||
|
Loading…
x
Reference in New Issue
Block a user