mirror/hdf5
2
0
Fork 0
mirror of https://github.com/HDFGroup/hdf5.git synced 2025-01-24 15:25:00 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update ReferenceManual.dox (#2517) (#2569)

Browse Source 
Co-authored-by: mattjala <124107509+mattjala@users.noreply.github.com>
This commit is contained in:
Larry Knox 2023-03-15 18:15:43 -05:00 committed by GitHub
parent fcd3b5a880
commit 6df5f12527
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doxygen/dox/ReferenceManual.dox
View File

@ -158,7 +158,7 @@ Follow these simple rules and stay out of trouble:
\li \Bold{Dynamic memory allocation:} The API contains a few functions in which the
HDF5 library dynamically allocates memory on the caller's behalf. The caller owns
this memory and eventually must free it by calling H5free_memory() and not language-explicit memory functions.
\li \Bold{Be careful with that saw:} Do not modify the underlying collection when an
\li \Bold{Don't modify while iterating:} Do not modify the underlying collection when an
iteration is in progress!
\li \Bold{Use of locations:} Certain API functions, typically called \Code{H5***_by_name}
use a combination of identifiers and path names to refer to HDF5 objects.