hdf5 icon indicating copy to clipboard operation
hdf5 copied to clipboard

Add documentation for `under construction` entries

Open hyoklee opened this issue 1 year ago • 5 comments

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
 */

hyoklee avatar Jun 12 '23 13:06 hyoklee

@derobins , I don't know what to do with this issue. Should I simply remove Under Construction line?

hyoklee avatar Jun 12 '23 16:06 hyoklee

@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.

derobins avatar Jun 12 '23 16:06 derobins

Please assign to code owner then. I don't know what to add.

hyoklee avatar Jun 13 '23 17:06 hyoklee

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

derobins avatar Jun 15 '23 14:06 derobins

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.

derobins avatar Jun 15 '23 14:06 derobins