mirror of
https://github.com/HDFGroup/hdf5.git
synced 2026-09-25 04:09:44 +03:00
Scot Breitenfeld
05676d1abe
* Consolidate documentation under doc/ directory
Move user-facing guides from release_docs/ and doxygen/ into a single
doc/ root. release_docs/ now holds only release artifacts (changelogs,
history, release process, maintainer info).
- git mv release_docs/INSTALL*.md, USING_*.md, README_HPC.md,
BuildSystemNotes.md, AutotoolsToCMakeOptions.md,
HDF5_Library_2.0.0_Migration_Guide.md → doc/
- git mv doxygen/ → doc/doxygen/
- Update CMakeLists.txt: HDF5_DOXYGEN_DIR and add_subdirectory path
- Update CMakeInstallation.cmake: all install paths for moved files
- Update bin/make_vers: hardcoded doxygen/ path substitution
- Update doc/doxygen/CMakeLists.txt: EXAMPLES_DIRECTORY and comments
- Update README.md, CONTRIBUTING.md, SECURITY.md, config/README.md,
release_docs/RELEASE_PROCESS.md: links to moved files
- Update doxygen .dox files: release_docs/ URLs for moved guides
- Rewrite release_docs/README.md for narrowed scope
* Add HDF5_DOCS_DIR variable for doc/ root path
Introduce HDF5_DOCS_DIR = \${HDF5_SOURCE_DIR}/doc so that
CMakeInstallation.cmake and future callers reference the doc/
directory symbolically rather than by hardcoded path.
HDF5_DOXYGEN_DIR is now derived from HDF5_DOCS_DIR.
49 lines
1.5 KiB
CMake
49 lines
1.5 KiB
CMake
# Generated automatically by bin/make_vers -- do not edit
|
|
# Add new versioned symbols to H5vers.txt file
|
|
#
|
|
# Doxygen PREDEFINED entries for versioned APIs
|
|
# These macros tell Doxygen which version each API name maps to,
|
|
# preventing "multiple @param documentation sections" warnings
|
|
|
|
list (APPEND _doxygen_predefined_entries
|
|
"H5Acreate=H5Acreate2"
|
|
"H5Aiterate=H5Aiterate2"
|
|
"H5Dcreate=H5Dcreate2"
|
|
"H5Dopen=H5Dopen2"
|
|
"H5Dread_chunk=H5Dread_chunk2"
|
|
"H5Eclear=H5Eclear2"
|
|
"H5Eget_auto=H5Eget_auto2"
|
|
"H5Eprint=H5Eprint2"
|
|
"H5Epush=H5Epush2"
|
|
"H5Eset_auto=H5Eset_auto2"
|
|
"H5Ewalk=H5Ewalk2"
|
|
"H5Fget_info=H5Fget_info2"
|
|
"H5Gcreate=H5Gcreate2"
|
|
"H5Gopen=H5Gopen2"
|
|
"H5Iregister_type=H5Iregister_type2"
|
|
"H5Lget_info=H5Lget_info2"
|
|
"H5Lget_info_by_idx=H5Lget_info_by_idx2"
|
|
"H5Literate=H5Literate2"
|
|
"H5Literate_by_name=H5Literate_by_name2"
|
|
"H5Lvisit=H5Lvisit2"
|
|
"H5Lvisit_by_name=H5Lvisit_by_name2"
|
|
"H5Oget_info=H5Oget_info3"
|
|
"H5Oget_info_by_idx=H5Oget_info_by_idx3"
|
|
"H5Oget_info_by_name=H5Oget_info_by_name3"
|
|
"H5Ovisit=H5Ovisit3"
|
|
"H5Ovisit_by_name=H5Ovisit_by_name3"
|
|
"H5Pencode=H5Pencode2"
|
|
"H5Pget_filter=H5Pget_filter2"
|
|
"H5Pget_filter_by_id=H5Pget_filter_by_id2"
|
|
"H5Pinsert=H5Pinsert2"
|
|
"H5Pregister=H5Pregister2"
|
|
"H5Rdereference=H5Rdereference2"
|
|
"H5Rget_obj_type=H5Rget_obj_type2"
|
|
"H5Sencode=H5Sencode2"
|
|
"H5Tarray_create=H5Tarray_create2"
|
|
"H5Tcommit=H5Tcommit2"
|
|
"H5Tdecode=H5Tdecode2"
|
|
"H5Tget_array_dims=H5Tget_array_dims2"
|
|
"H5Topen=H5Topen2"
|
|
)
|