Convert file format html files to doxygen (#5204)

HDFGroup · Jan 7, 2025 · d788d0a · d788d0a
1 parent 67d074c
commit d788d0a
Show file tree

Hide file tree

Showing 12 changed files with 28,243 additions and 46,343 deletions.
diff --git a/.github/workflows/netcdf.yml b/.github/workflows/netcdf.yml
@@ -52,6 +52,7 @@ jobs:
             -DHDF5_BUILD_DOC:BOOL=OFF \
             -DHDF5_ENABLE_ZLIB_SUPPORT:BOOL=ON \
             -DZLIB_USE_LOCALCONTENT:BOOL=OFF \
+            -DHDF5_ENABLE_ZLIB_SUPPORT:BOOL=ON \
             -DH5_NO_DEPRECATED_SYMBOLS:BOOL=OFF \
             -DBUILD_TESTING:BOOL=OFF \
             -DCMAKE_INSTALL_PREFIX:PATH=/usr/local \

diff --git a/CMakeFilters.cmake b/CMakeFilters.cmake
@@ -85,6 +85,7 @@ endif ()
 if(NOT DEFINED ZLIBNG_PACKAGE_NAME)
   set(ZLIBNG_PACKAGE_NAME "zlib-ng")
 endif ()
+option (HDF5_ENABLE_ZLIB_SUPPORT "Enable Zlib Filters" OFF)
 if (HDF5_ENABLE_ZLIB_SUPPORT)
   if (NOT H5_ZLIB_HEADER)
     if (NOT ZLIB_USE_EXTERNAL)
@@ -160,6 +161,7 @@ set(H5_SZIP_FOUND FALSE)
 if(NOT DEFINED LIBAEC_PACKAGE_NAME)
   set(LIBAEC_PACKAGE_NAME "libaec")
 endif ()
+option (HDF5_ENABLE_SZIP_SUPPORT "Use SZip Filter" OFF)
 if (HDF5_ENABLE_SZIP_SUPPORT)
   option (HDF5_ENABLE_SZIP_ENCODING "Use SZip Encoding" ON)
   if (NOT SZIP_USE_EXTERNAL)

diff --git a/doxygen/dox/FileFormatSpec.dox b/doxygen/dox/FileFormatSpec.dox
@@ -1,23 +1,7 @@
-/** \page FMT3 HDF5 File Format Specification Version 3.0
+\ref FMT3
 
-\htmlinclude H5.format.html
+\ref FMT2
 
-*/
+\ref FMT11
 
-/** \page FMT2 HDF5 File Format Specification Version 2.0
-
-\htmlinclude H5.format.2.0.html
-
-*/
-
-/** \page FMT11 HDF5 File Format Specification Version 1.1
-
-\htmlinclude H5.format.1.1.html
-
-*/
-
-/** \page FMT1 HDF5 File Format Specification Version 1.0
-
-\htmlinclude H5.format.1.0.html
-
-*/
+\ref FMT1
diff --git a/doxygen/dox/H5.format.1.0.dox b/doxygen/dox/H5.format.1.0.dox
diff --git a/doxygen/dox/H5.format.1.1.dox b/doxygen/dox/H5.format.1.1.dox
diff --git a/doxygen/dox/H5.format.2.0.dox b/doxygen/dox/H5.format.2.0.dox
diff --git a/doxygen/dox/H5.format.3.0.dox b/doxygen/dox/H5.format.3.0.dox
diff --git a/doxygen/dox/Specifications.dox b/doxygen/dox/Specifications.dox
@@ -9,10 +9,10 @@
 
 \section File Format
 
-\li \ref FMT1SPEC
-\li \ref FMT11SPEC
-\li \ref FMT2SPEC
-\li \ref FMT3SPEC
+\li \ref FMT1
+\li \ref FMT11
+\li \ref FMT2
+\li \ref FMT3
 
 \section Other
 
@@ -21,27 +21,3 @@
 \li \ref sec_dim_scales_spec
 
 */
-
-/** \page FMT3SPEC HDF5 File Format Specification Version 3.0
-
-\htmlinclude H5.format.html
-
-*/
-
-/** \page FMT2SPEC HDF5 File Format Specification Version 2.0
-
-\htmlinclude H5.format.2.0.html
-
-*/
-
-/** \page FMT11SPEC HDF5 File Format Specification Version 1.1
-
-\htmlinclude H5.format.1.1.html
-
-*/
-
-/** \page FMT1SPEC HDF5 File Format Specification Version 1.0
-
-\htmlinclude H5.format.1.0.html
-
-*/