diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2024-01-29 13:38:54 (GMT) |
---|---|---|
committer | Larry Knox <lrknox@hdfgroup.org> | 2024-02-14 21:30:28 (GMT) |
commit | 56d9be146fb27456e4c517e49ccf920396824d71 (patch) | |
tree | e6287952c20487797f17cea9878bd60f9d51dbfb /doxygen | |
parent | 6ec07ffa9a096791fbb2c6735bd14cdcac24ab5d (diff) | |
download | hdf5-56d9be146fb27456e4c517e49ccf920396824d71.zip hdf5-56d9be146fb27456e4c517e49ccf920396824d71.tar.gz hdf5-56d9be146fb27456e4c517e49ccf920396824d71.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 'doxygen')
-rw-r--r-- | doxygen/dox/LearnBasics3.dox | 2 | ||||
-rw-r--r-- | doxygen/dox/PredefinedDatatypeTables.dox | 35 | ||||
-rw-r--r-- | doxygen/examples/tables/fileDriverLists.dox | 2 |
3 files changed, 28 insertions, 11 deletions
diff --git a/doxygen/dox/LearnBasics3.dox b/doxygen/dox/LearnBasics3.dox index 435187e..195213b 100644 --- a/doxygen/dox/LearnBasics3.dox +++ b/doxygen/dox/LearnBasics3.dox @@ -288,7 +288,7 @@ is met, at a certain point in the future.) \section secLBContentsProg Programming Example -\subsection subsecLBContentsProgUsing Using #H5Literate, #H5Lvisit and #H5Ovisit +\subsection subsecLBContentsProgUsing Using H5Literate, H5Lvisit and H5Ovisit For example code, see the \ref HDF5Examples page. Specifically look at the \ref ExAPI. There are examples for different languages, where examples of using #H5Literate and #H5Ovisit/#H5Lvisit are included. diff --git a/doxygen/dox/PredefinedDatatypeTables.dox b/doxygen/dox/PredefinedDatatypeTables.dox index fbafa94..0b40516 100644 --- a/doxygen/dox/PredefinedDatatypeTables.dox +++ b/doxygen/dox/PredefinedDatatypeTables.dox @@ -1,22 +1,41 @@ /** \page predefined_datatypes_tables HDF5 Predefined Datatypes + * + * \section sec_predefined_datatypes_tables HDF5 Predefined Datatypes * * The following datatypes are predefined in HDF5. - * + * <div> * \snippet{doc} tables/predefinedDatatypes.dox predefined_ieee_datatypes_table + * </div> * + * <div> * \snippet{doc} tables/predefinedDatatypes.dox predefined_std_datatypes_table - * + * </div> + * + * <div> * \snippet{doc} tables/predefinedDatatypes.dox predefined_unix_datatypes_table - * + * </div> + * + * <div> * \snippet{doc} tables/predefinedDatatypes.dox predefined_string_datatypes_table - * + * </div> + * + * <div> * \snippet{doc} tables/predefinedDatatypes.dox predefined_intel_datatypes_table - * + * </div> + * + * <div> * \snippet{doc} tables/predefinedDatatypes.dox predefined_dec_datatypes_table - * + * </div> + * + * <div> * \snippet{doc} tables/predefinedDatatypes.dox predefined_mips_datatypes_table - * + * </div> + * + * <div> * \snippet{doc} tables/predefinedDatatypes.dox predefined_native_datatypes_table - * + * </div> + * + * <div> * \snippet{doc} tables/predefinedDatatypes.dox predefined_c9x_datatypes_table + * </div> */ diff --git a/doxygen/examples/tables/fileDriverLists.dox b/doxygen/examples/tables/fileDriverLists.dox index b1f873f..437d32a 100644 --- a/doxygen/examples/tables/fileDriverLists.dox +++ b/doxygen/examples/tables/fileDriverLists.dox @@ -1,5 +1,4 @@ /** File Driver List - * //! [file_driver_table] <table> <caption>I/O file drivers</caption> @@ -70,7 +69,6 @@ </table> //! [file_driver_table] * - * //! [supported_file_driver_table] <table> <caption id="table_file_drivers">Supported file drivers</caption> |