hdf5
hdf5 copied to clipboard
Add documentation for `under construction` entries
Many header files have "@todo Under Construction" entries in Doxygen. These should be replaced with actual documentation by the next release.
hl/src/H5DOpublic.h
in 1.14.1-2 says
/** \page H5DO_UG The HDF5 High Level Optimizations
* @todo Under Construction
*/
@derobins , I don't know what to do with this issue.
Should I simply remove Under Construction
line?
@derobins , I don't know what to do with this issue. Should I simply remove
Under Construction
line?
I think we should add the documentation.
Please assign to code owner then. I don't know what to add.
A full list of these sections:
src/H5Omodule.h 29: * @todo Under Construction
src/H5Rmodule.h 28: * @todo Under Construction
src/H5Imodule.h 29: * @todo Under Construction
src/H5PLmodule.h 30: * @todo Under Construction
src/H5Lmodule.h 29: * @todo Under Construction
src/H5ESmodule.h 29: * @todo Under Construction
src/H5Zmodule.h 29: * @todo Under Construction
hl/src/H5DOpublic.h 21: * @todo Under Construction
hl/src/H5DSpublic.h 34: * @todo Under Construction
hl/src/H5TBpublic.h 21: * @todo Under Construction
hl/src/H5PTpublic.h 21: * @todo Under Construction
hl/src/H5LTpublic.h 38: * @todo Under Construction
hl/src/H5IMpublic.h 21: * @todo Under Construction
It looks like many of these files have at least some text. @byrnHDF - why do these tags still exist? Can we just remove them? Maybe we should yank them and have a GitHub wiki page for requested documentation improvements instead.