summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2024-01-29 13:38:54 (GMT)
committerGitHub <noreply@github.com>2024-01-29 13:38:54 (GMT)
commit365e23340cd001ee751da366235ae420156ad728 (patch)
tree49d5a73db00b4eb8ecdd8c872027f58265e18ba4 /src
parent1bea9e6100fd7c92caf31eba96766aa8ec4f356c (diff)
downloadhdf5-365e23340cd001ee751da366235ae420156ad728.zip
hdf5-365e23340cd001ee751da366235ae420156ad728.tar.gz
hdf5-365e23340cd001ee751da366235ae420156ad728.tar.bz2
Fix doxygen errors (#3962)
* Switch warnings as errors to default OFF * Enable mac docs * Add doxygen action uses step * Use html div around snippet * Allow preset name to be an argument to cmake-ctest.yml
Diffstat (limited to 'src')
-rw-r--r--src/H5Dmodule.h9
-rw-r--r--src/H5Fmodule.h9
-rw-r--r--src/H5Gmodule.h2
-rw-r--r--src/H5Pmodule.h75
-rw-r--r--src/H5Ppublic.h3
-rw-r--r--src/H5Tmodule.h18
-rw-r--r--src/H5VLmodule.h6
7 files changed, 103 insertions, 19 deletions
diff --git a/src/H5Dmodule.h b/src/H5Dmodule.h
index 84d00e8..81f197d 100644
--- a/src/H5Dmodule.h
+++ b/src/H5Dmodule.h
@@ -179,10 +179,15 @@
* </table>
*
* \anchor dcpl_table_tag Dataset creation property list functions (H5P)
+ * <div>
* \snippet{doc} tables/propertyLists.dox dcpl_table
+ * </div>
*
* \anchor dapl_table_tag Dataset access property list functions (H5P)
+ *
+ * <div>
* \snippet{doc} tables/propertyLists.dox dapl_table
+ * </div>
*
* \subsection subsec_dataset_program Programming Model for Datasets
* This section explains the programming model for datasets.
@@ -863,7 +868,9 @@
* the pipeline processing: the pipeline and filter operations are identical no matter what data access
* mechanism is used.
*
+ * <div>
* \snippet{doc} tables/propertyLists.dox lcpl_table
+ * </div>
*
* Each file driver writes/reads contiguous blocks of bytes from a logically contiguous address
* space. The file driver is responsible for managing the details of the different physical storage
@@ -880,7 +887,9 @@
* Data transfer properties set optional parameters that control parts of the data pipeline. The
* function listing below shows transfer properties that control the behavior of the library.
*
+ * <div>
* \snippet{doc} tables/fileDriverLists.dox file_driver_table
+ * </div>
*
* Some filters and file drivers require or use additional parameters from the application program.
* These can be passed in the data transfer property list. The table below shows file driver property
diff --git a/src/H5Fmodule.h b/src/H5Fmodule.h
index b7bb7a0..bf54976 100644
--- a/src/H5Fmodule.h
+++ b/src/H5Fmodule.h
@@ -408,14 +408,19 @@
* </table>
*
* \anchor fcpl_table_tag File creation property list functions (H5P)
+ * <div>
* \snippet{doc} tables/propertyLists.dox fcpl_table
+ * </div>
*
* \anchor fapl_table_tag File access property list functions (H5P)
+ * <div>
* \snippet{doc} tables/propertyLists.dox fapl_table
+ * </div>
*
* \anchor fd_pl_table_tag File driver property list functions (H5P)
+ * <div>
* \snippet{doc} tables/propertyLists.dox fd_pl_table
- *
+ * </div>
*
* \subsection subsec_file_create Creating or Opening an HDF5 File
* This section describes in more detail how to create and how to open files.
@@ -672,7 +677,9 @@
* #H5FD_SEC2. Alternative layouts and drivers are designed to suit the needs of a variety of
* systems, environments, and applications. The drivers are listed in the table below.
*
+ * <div>
* \snippet{doc} tables/fileDriverLists.dox supported_file_driver_table
+ * </div>
*
* For more information, see the HDF5 Reference Manual entries for the function calls shown in
* the column on the right in the table above.
diff --git a/src/H5Gmodule.h b/src/H5Gmodule.h
index 4c435eb..c330fcd 100644
--- a/src/H5Gmodule.h
+++ b/src/H5Gmodule.h
@@ -477,7 +477,9 @@
* </tr>
* </table>
*
+ * <div>
* \snippet{doc} tables/propertyLists.dox gcpl_table
+ * </div>
*
* <table>
* <caption>Other external link functions</caption>
diff --git a/src/H5Pmodule.h b/src/H5Pmodule.h
index ea0b2de..ef300f9 100644
--- a/src/H5Pmodule.h
+++ b/src/H5Pmodule.h
@@ -891,48 +891,75 @@
* properties. Property lists are deleted by closing the associated handles.
*
* \ref PLCR
+ * <div>
* \snippet{doc} tables/propertyLists.dox plcr_table
+ * </div>
*
* \ref PLCR
+ * <div>
* \snippet{doc} tables/propertyLists.dox plcra_table
+ * </div>
*
* \ref PLCR / \ref OCPL / \ref GCPL
+ * <div>
* \snippet{doc} tables/propertyLists.dox fcpl_table
+ * </div>
*
* \ref PLCR
+ * <div>
* \snippet{doc} tables/propertyLists.dox fapl_table
* \snippet{doc} tables/propertyLists.dox fd_pl_table
+ * </div>
*
* \ref PLCR
+ * <div>
* \snippet{doc} tables/propertyLists.dox lapl_table
+ * </div>
*
* \ref PLCR / \ref OCPL
+ * <div>
* \snippet{doc} tables/propertyLists.dox dcpl_table
+ * </div>
*
* \ref PLCR / \ref LAPL
+ * <div>
* \snippet{doc} tables/propertyLists.dox dapl_table
+ * </div>
*
* \ref PLCR / \ref OCPL
+ * <div>
* \snippet{doc} tables/propertyLists.dox gcpl_table
+ * </div>
*
* \ref PLCR / \ref LAPL
+ * <div>
* \snippet{doc} tables/propertyLists.dox gapl_table
+ * </div>
*
* \ref PLCR
+ * <div>
* \snippet{doc} tables/propertyLists.dox ocpl_table
+ * </div>
*
* \ref PLCR
+ * <div>
* \snippet{doc} tables/propertyLists.dox ocpypl_table
+ * </div>
*
* \ref PLCR
+ * <div>
* \snippet{doc} tables/propertyLists.dox strcpl_table
+ * </div>
*
* \ref PLCR / \ref STRCPL
+ * <div>
* \snippet{doc} tables/propertyLists.dox lcpl_table
+ * </div>
*
* \ref PLCR / \ref STRCPL
+ * <div>
* \snippet{doc} tables/propertyLists.dox acpl_table
- *
+ * </div>
*
* \defgroup STRCPL String Creation Properties
* \ingroup H5P
@@ -941,30 +968,33 @@
* choice of a character encoding, applies to both attributes and links.
* The second creation property applies to links only, and advises the library
* to automatically create missing intermediate groups when creating new objects.
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox strcpl_table
+ * </div>
*
* \defgroup LCPL Link Creation Properties
* \ingroup STRCPL
* This creation property applies to links only, and advises the library
* to automatically create missing intermediate groups when creating new objects.
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox lcpl_table
- *
+ * </div>
* @see STRCPL
*
* \defgroup ACPL Attribute Creation Properties
* \ingroup STRCPL
* The creation property, the choice of a character encoding, applies to attributes.
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox acpl_table
+ * </div>
*
* @see STRCPL
*
* \defgroup LAPL Link Access Properties
* \ingroup H5P
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox lapl_table
+ * </div>
*
* \defgroup DAPL Dataset Access Properties
* \ingroup LAPL
@@ -974,8 +1004,9 @@
* dataset file paths, and controlling flush behavior, etc. These properties
* are \Emph{not} persisted with datasets, and can be adjusted at runtime before
* a dataset is created or opened.
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox dapl_table
+ * </div>
*
* \defgroup DCPL Dataset Creation Properties
* \ingroup OCPL
@@ -984,8 +1015,9 @@
* Unlike dataset access and transfer properties, creation properties \Emph{are}
* stored with the dataset, and cannot be changed once a dataset has been
* created.
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox dcpl_table
+ * </div>
*
* \defgroup DXPL Dataset Transfer Properties
* \ingroup H5P
@@ -993,8 +1025,9 @@
* and writing datasets such as transformations, MPI-IO I/O mode, error
* detection, etc. These properties are \Emph{not} persisted with datasets,
* and can be adjusted at runtime before a dataset is read or written.
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox dxpl_table
+ * </div>
*
* \defgroup FAPL File Access Properties
* \ingroup H5P
@@ -1003,9 +1036,10 @@
* file driver (VFD), configuring the metadata cache (MDC), control
* file locking, etc. These properties are \Emph{not} persisted with files, and
* can be adjusted at runtime before a file is created or opened.
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox fapl_table
* \snippet{doc} tables/propertyLists.dox fd_pl_table
+ * </div>
*
* \defgroup FCPL File Creation Properties
* \ingroup GCPL
@@ -1014,14 +1048,16 @@
* Unlike file access properties, creation properties \Emph{are}
* stored with the file, and cannot be changed once a file has been
* created.
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox fcpl_table
+ * </div>
*
* \defgroup GAPL Group Access Properties
* \ingroup LAPL
* The functions in this section can be applied to group property lists.
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox gapl_table
+ * </div>
*
* \defgroup GCPL Group Creation Properties
* \ingroup OCPL
@@ -1030,32 +1066,37 @@
* Unlike file access properties, creation properties \Emph{are}
* stored with the group, and cannot be changed once a group has been
* created.
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox gcpl_table
+ * </div>
*
* \defgroup PLCR Property List Class Root
* \ingroup H5P
* Use the functions in this module to manage HDF5 property lists.
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox plcr_table
+ * </div>
*
* \defgroup PLCRA Property List Class Root (Advanced)
* \ingroup H5P
* You can create and customize user-defined property list classes using the
* functions described below. Arbitrary user-defined properties can also
* be inserted into existing property lists as so-called temporary properties.
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox plcra_table
+ * </div>
*
* \defgroup OCPL Object Creation Properties
* \ingroup H5P
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox ocpl_table
+ * </div>
*
* \defgroup OCPYPL Object Copy Properties
* \ingroup H5P
- *
+ * <div>
* \snippet{doc} tables/propertyLists.dox ocpypl_table
+ * </div>
*
* \defgroup FMPL File Mount Properties
* \ingroup H5P
diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h
index 98b7c2f..721f3d7 100644
--- a/src/H5Ppublic.h
+++ b/src/H5Ppublic.h
@@ -3360,8 +3360,9 @@ H5_DLL herr_t H5Pget_core_write_tracking(hid_t fapl_id, hbool_t *is_enabled, siz
*
* Valid driver identifiers distributed with HDF5 are listed and
* described in the following table.
- *
+ * <div>
* \snippet{doc} tables/fileDriverLists.dox supported_file_driver_table
+ * </div>
*
* This list does not include custom drivers that might be
* defined and registered by a user.
diff --git a/src/H5Tmodule.h b/src/H5Tmodule.h
index b4f9289..f1b7b17 100644
--- a/src/H5Tmodule.h
+++ b/src/H5Tmodule.h
@@ -3892,30 +3892,42 @@ filled according to the value of this property. The padding can be:
* \details CPU-specific datatypes
* \defgroup PDTALPHA DEC Alpha
* \ingroup PDTCPU
+ * <div>
* \snippet{doc} tables/predefinedDatatypes.dox predefined_dec_datatypes_table
+ * </div>
* \defgroup PDTX86 AMD & INTEL
* \ingroup PDTCPU
+ * <div>
* \snippet{doc} tables/predefinedDatatypes.dox predefined_intel_datatypes_table
+ * </div>
* \defgroup PDTMIPS SGI MIPS
* \ingroup PDTCPU
+ * <div>
* \snippet{doc} tables/predefinedDatatypes.dox predefined_mips_datatypes_table
+ * </div>
*
* \defgroup PDTIEEE IEEE
* \ingroup PDT
* \details The IEEE floating point types in big- and little-endian byte orders.
+ * <div>
* \snippet{doc} tables/predefinedDatatypes.dox predefined_ieee_datatypes_table
+ * </div>
*
* \defgroup PDTSTD Standard Datatypes
* \ingroup PDT
* \details These are "standard" types. For instance, signed (2's complement)
* and unsigned integers of various sizes in big- and little-endian
* byte orders.
+ * <div>
* \snippet{doc} tables/predefinedDatatypes.dox predefined_std_datatypes_table
+ * </div>
*
* \defgroup PDTUNIX UNIX-specific Datatypes
* \ingroup PDT
* \details Types which are particular to Unix.
+ * <div>
* \snippet{doc} tables/predefinedDatatypes.dox predefined_unix_datatypes_table
+ * </div>
*
* \defgroup PDTNAT Native Datatypes
* \ingroup PDT
@@ -3928,16 +3940,22 @@ filled according to the value of this property. The padding can be:
* \li The datatype \c LLONG corresponds C's \Code{long long} and
* \c LDOUBLE is \Code{long double}. These types might be the same
* as \c LONG and \c DOUBLE, respectively.
+ * <div>
* \snippet{doc} tables/predefinedDatatypes.dox predefined_native_datatypes_table
+ * </div>
*
* \defgroup PDTC9x C9x Integer Datatypes
* \ingroup PDTNAT
* \details C9x integer types
+ * <div>
* \snippet{doc} tables/predefinedDatatypes.dox predefined_c9x_datatypes_table
+ * </div>
*
* \defgroup PDTS Strings
* \ingroup PDT
+ * <div>
* \snippet{doc} tables/predefinedDatatypes.dox predefined_string_datatypes_table
+ * </div>
*
*/
diff --git a/src/H5VLmodule.h b/src/H5VLmodule.h
index 546b31e..19baf34 100644
--- a/src/H5VLmodule.h
+++ b/src/H5VLmodule.h
@@ -606,15 +606,21 @@
* fact, implement some of this functionality as it is possible to mimic the native
* HDF5 connector, however this will probably not be true for most non-native
* VOL connectors.
+ * <div>
* \snippet{doc} tables/volAPIs.dox vol_native_table
+ * </div>
*
* \subsubsection subsubsec_vol_compat_indep List of HDF5 VOL-Independent API Calls
* These HDF5 API calls do not depend on a particular VOL connector being loaded.
+ * <div>
* \snippet{doc} tables/volAPIs.dox vol_independent_table
+ * </div>
*
* \subsubsection subsubsec_vol_compat_opt List of Native VOL Optional Operation Values By Subclass
* These values can be passed to the opt type parameter of H5VLquery optional().
+ * <div>
* \snippet{doc} tables/volAPIs.dox vol_optional_table
+ * </div>
*
*
*