Hello,
I noticed that the H5Pget_filter_by_id1/2 functions are declared in the
public header as returning H5Z_filter_t, just like H5Pget_filter1/2.
However, the actual implementation returns herr_t. As a consequence, I
expected H5Pget_filter_by_id to return one of the H5Z_FILTER_* constants,
but instead a successful call seems to return 0.
As an aside, I've converted the majority of the HDF5 API docs into a Doxygen
(http://www.stack.nl/~dimitri/doxygen/) comment format for use with my own
project. Doxygen is widely used in the open source C/C++ community. I wonder
if the HDF group would be interested in incorporated the API doc comments
into the public headers of the HDF5 library. This might make it easier to
maintain, and would make the headers easier to use in content-aware IDEs
like Visual Studio.
Hello Solomon,
Hello,
I noticed that the H5Pget_filter_by_id1/2 functions are declared in the public header as returning H5Z_filter_t, just like H5Pget_filter1/2.
However, the actual implementation returns herr_t. As a consequence, I expected H5Pget_filter_by_id to return one of the H5Z_FILTER_* constants, but instead a successful call seems to return 0.
Thank you for your report. I added an entry to our Bugzilla DB.
As an aside, I've converted the majority of the HDF5 API docs into a Doxygen (http://www.stack.nl/~dimitri/doxygen/) comment format for use with my own project. Doxygen is widely used in the open source C/C++ community. I wonder if the HDF group would be interested in incorporated the API doc comments into the public headers of the HDF5 library. This might make it easier to maintain, and would make the headers easier to use in content-aware IDEs like Visual Studio.
We use Doxygen to generate HDF5 C++ documentation and it works very well. We also have been considering different ways of generating HDF5 C and Fortran documentation but haven't made any decisions/commitments yet. It would be great if you can share with us your work.
Thanks a lot,
Elena
ยทยทยท
On Jul 17, 2009, at 7:25 AM, Solomon Gibbs wrote:
_______________________________________________
Hdf-forum is for HDF software users discussion.
Hdf-forum@hdfgroup.org
http://mail.hdfgroup.org/mailman/listinfo/hdf-forum_hdfgroup.org
