Convert Debugging HDF5 Applications to doxygen #5139
Conversation
byrnHDF
added
Priority - 2. Medium ⏹
byrnHDF
requested review from
lrknox,
derobins,
fortnern,
jhendersonHDF,
qkoziol,
vchoi-hdfgroup,
bmribler,
glennsong09,
mattjala and
brtnfld
as code owners
doxygen/dox/TechnicalNotes.dox
Outdated
| In addition to including the code at compile time the application must enable each package at | ||
| runtime. This is done by listing the package names in the HDF5_DEBUG environment variable. That | ||
| variable may also contain file descriptor numbers (the default is 2') which control the output | ||
| for all following packages up to the next file number. The word all` refers to all packages. Any |
There was a problem hiding this comment.
Are these stray ' and ` in the 2 lines above?
Also should the ` in in line 287 be changed to '?
doxygen/dox/TechnicalNotes.dox
Outdated
| </table> | ||
| The components of the HDF5_DEBUG value may be separated by any non-lowercase letter. | ||
|
|
||
| \section sec_adddbg_trace API Tracing |
There was a problem hiding this comment.
Essentially everything from this point down can just be removed since the API tracing functionality was removed a bit ago.
There was a problem hiding this comment.
That is what I thought! Good so this goes away.
doxygen/dox/TechnicalNotes.dox
Outdated
| \section sec_adddbg_intro Introduction | ||
| The HDF5 library contains a number of debugging features to make programmers' lives | ||
| easier including the ability to print detailed error messages, check invariant | ||
| conditions, display timings and other statistics, and trace API function calls |
There was a problem hiding this comment.
Which would also warrant revision here
There was a problem hiding this comment.
But wait - we still have H5ARG_TRACE and bin/trace?
There was a problem hiding this comment.
|trace|Updates H5ARG_TRACE macros in H5ES_insert() calls (run by autogen.sh)|
There was a problem hiding this comment.
They trace function calls just for internal use with the Async APIs but in general the H5TRACE macros were removed from all API routines.
There was a problem hiding this comment.
So safe to remove in this file - good!
Is this info even correct anymore?