diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2023-06-19 05:21:40 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-06-19 05:21:40 (GMT) |
commit | d31a017e6c15fcb5f8ed16806b7259eadb8c350a (patch) | |
tree | 03bff3009a78b2fdded29b96c5f4efd151a3a97b /doxygen | |
parent | 622e3b762917061cd226e2d1659ec8e7076bece3 (diff) | |
download | hdf5-d31a017e6c15fcb5f8ed16806b7259eadb8c350a.zip hdf5-d31a017e6c15fcb5f8ed16806b7259eadb8c350a.tar.gz hdf5-d31a017e6c15fcb5f8ed16806b7259eadb8c350a.tar.bz2 |
Various merges from develop (#3135)
* Merges from develop/1.14
* Fix doxygen warnings
* Fix spelling
* Fix doxygen ref
* Add braces
* Fix format
* Remove unused file
Diffstat (limited to 'doxygen')
-rw-r--r-- | doxygen/Doxyfile.in | 2 | ||||
-rw-r--r-- | doxygen/dox/LearnBasics3.dox | 2 | ||||
-rw-r--r-- | doxygen/dox/ReferenceManual.dox | 1 | ||||
-rw-r--r-- | doxygen/examples/menus/core_menu.md | 4 | ||||
-rw-r--r-- | doxygen/examples/tables/predefinedDatatypes.dox | 2 |
5 files changed, 3 insertions, 8 deletions
diff --git a/doxygen/Doxyfile.in b/doxygen/Doxyfile.in index 3d4a766..f35966d 100644 --- a/doxygen/Doxyfile.in +++ b/doxygen/Doxyfile.in @@ -625,7 +625,7 @@ WARN_NO_PARAMDOC = NO # a warning is encountered. # The default value is: NO. -WARN_AS_ERROR = NO +WARN_AS_ERROR = FAIL_ON_WARNINGS # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which diff --git a/doxygen/dox/LearnBasics3.dox b/doxygen/dox/LearnBasics3.dox index 06afacd..7487458 100644 --- a/doxygen/dox/LearnBasics3.dox +++ b/doxygen/dox/LearnBasics3.dox @@ -945,7 +945,7 @@ For a more complete script (and to help resolve issues) see the script provided \subsection subsecLBCompilingCMakeExamples HDF5 Examples The installed HDF5 can be verified by compiling the HDF5 Examples project, included with the CMake built HDF5 binaries -in the share folder or you can go to the <a href="https://github.com/HDFGroup/hdf5_examples">HDF5 Examples</a> github repository. +in the share folder or you can go to the <a href="https://github.com/HDFGroup/hdf5-examples">HDF5 Examples</a> github repository. Go into the share directory and follow the instructions in USING_CMake_examples.txt to build the examples. diff --git a/doxygen/dox/ReferenceManual.dox b/doxygen/dox/ReferenceManual.dox index 5b46a19..eaf3912 100644 --- a/doxygen/dox/ReferenceManual.dox +++ b/doxygen/dox/ReferenceManual.dox @@ -131,7 +131,6 @@ The functions provided by the HDF5 API are grouped into the following <td> \ref predefined_datatypes_tables<br /> <a href="./deprecated.html">Deprecated functions</a><br /> -Functions with \ref ASYNC<br /> \ref api-compat-macros </td> </tr> diff --git a/doxygen/examples/menus/core_menu.md b/doxygen/examples/menus/core_menu.md index 3fd7d11..8c82cc5 100644 --- a/doxygen/examples/menus/core_menu.md +++ b/doxygen/examples/menus/core_menu.md @@ -20,10 +20,6 @@ HDF5 datatypes describe the element type of HDF5 datasets and attributes. <br /> HDF5 library error reporting. -- @ref H5ES "Event Set (H5ES)" -<br /> -HDF5 event set life cycle used with HDF5 VOL connectors that enable the asynchronous feature in HDF5. - - @ref H5F "Files (H5F)" <br /> Manage HDF5 files. diff --git a/doxygen/examples/tables/predefinedDatatypes.dox b/doxygen/examples/tables/predefinedDatatypes.dox index 1deb882..36d6b73 100644 --- a/doxygen/examples/tables/predefinedDatatypes.dox +++ b/doxygen/examples/tables/predefinedDatatypes.dox @@ -469,7 +469,7 @@ <td>C-style double</td> </tr> <tr> -<td>#H5T_NATIVE_LDOUBLE</td> +<td>H5T_NATIVE_LDOUBLE</td> <td>C-style long double</td> </tr> <tr> |