mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-03-31 17:10:47 +08:00
Code Issues Packages Projects Releases Wiki Activity

A couple of documentation items to fix (#3332)

Browse Source
This commit is contained in:
Allen Byrne 2023-08-02 15:16:26 -05:00 committed by GitHub
parent 7ed8dd7813
commit 8e9c281cf1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.clang-format
View File

@ -85,7 +85,6 @@ StatementMacros:
- H5_GCC_DIAG_ON
- H5_LEAVE
- HGOTO_DONE
- HGOTO_ERROR
- HMPI_DONE_ERROR
- HMPI_ERROR
- HMPI_GOTO_ERROR

8
doc/getting-started-with-hdf5-development.md
View File

@ -270,7 +270,7 @@ H5X_do_stuff(/*parameters*/)
HDassert(/*parameter check*/);
if (H5X_other_call() < 0)
HGOTO_ERROR(H5E_MAJ, H5E_MIN, FAIL, "badness")
HGOTO_ERROR(H5E_MAJ, H5E_MIN, FAIL, "badness");
done:
if (ret_value < 0)
@ -329,12 +329,12 @@ H5Xdo_api_stuff(/*parameters*/)
H5TRACE3(/*stuff*/)
if (/*parameter check*/)
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "badness")
HGOTO_ERROR(H5E_ARGS, H5E_BADVALUE, FAIL, "badness");
/* VOL setup */
if (H5VL_call() < 0)
HGOTO_ERROR(H5E_FOO, H5E_BAR, FAIL, "badness")
HGOTO_ERROR(H5E_FOO, H5E_BAR, FAIL, "badness");
done:
if (ret_value < 0)
@ -483,7 +483,7 @@ fail. The general format is this:
```c
if (function_that_could_fail(foo, bar) < 0)
HGOTO_ERROR(H5E_<major>, H5E_<minor>, <bad value>, "tell me about badness")
HGOTO_ERROR(H5E_<major>, H5E_<minor>, <bad value>, "tell me about badness");
```
`HGOTO_ERROR` is one of a set of macros defined in `H5Eprivate.h`. This macro