Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Removed the file, func, line args in the _async APIs fpr doxygen #2179

Merged
merged 13 commits into from
Oct 25, 2022
Merged

Removed the file, func, line args in the _async APIs fpr doxygen #2179

merged 13 commits into from
Oct 25, 2022

Conversation

brtnfld
Copy link
Contributor

@brtnfld brtnfld commented Oct 21, 2022

Removed the file, func, line args in the _async APIs from the doxygen arguments. Documented H5ESclean.

byrnHDF
byrnHDF reviewed Oct 21, 2022
View reviewed changes
doxygen/Doxyfile.in Outdated Show resolved Hide resolved
brtnfld
brtnfld commented Oct 21, 2022
View reviewed changes
configure.ac Outdated Show resolved Hide resolved
@brtnfld
Copy link
Contributor Author

brtnfld commented Oct 21, 2022 •
edited
Loading

I see the issue, fixing now.

jhendersonHDF
jhendersonHDF reviewed Oct 21, 2022
View reviewed changes
src/H5Apublic.h Outdated Show resolved Hide resolved
@brtnfld brtnfld marked this pull request as draft October 21, 2022 16:49
@brtnfld
Copy link
Contributor Author

brtnfld commented Oct 21, 2022

Fixed #ifdef logic.

@fortnern can you verify the missing varg definitions in H5Dpublic.h are correct.

@brtnfld brtnfld marked this pull request as ready for review October 21, 2022 17:23
fortnern
fortnern reviewed Oct 21, 2022
View reviewed changes
src/H5Dpublic.h Outdated Show resolved Hide resolved
@brtnfld
Copy link
Contributor Author

brtnfld commented Oct 24, 2022

@jhendersonHDF is the examples of H5Aclose_async and H5Acreate_async in H5Apublic.h what you had in mind?
@byrnHDF do you see any issue with doing it this way? I guess doxygen would see for H5Aclose_async the full API but not have a group to put it into, so it does not show up.

brtnfld
brtnfld commented Oct 24, 2022
View reviewed changes
src/H5Apublic.h
* \async_variant_of{H5Aclose}
*/
H5_DLL herr_t H5Aclose_async(const char *app_file, const char *app_func, unsigned app_line, hid_t attr_id,
hid_t es_id);
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

moved this to a doxygen region below, and just have the full API

brtnfld
brtnfld commented Oct 24, 2022
View reviewed changes
src/H5Apublic.h Outdated
@@ -974,6 +993,21 @@ H5_DLL herr_t H5Awrite_async(const char *app_file, const char *app_func, unsigne
H5_DLL herr_t H5Arename_by_name(hid_t loc_id, const char *obj_name, const char *old_attr_name,
const char *new_attr_name, hid_t lapl_id);

#ifdef H5_DOXYGEN
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The doxygen region for the _async APIs.

@jhendersonHDF
Copy link
Collaborator

@jhendersonHDF is the examples of H5Aclose_async and H5Acreate_async in H5Apublic.h what you had in mind? @byrnHDF do you see any issue with doing it this way? I guess doxygen would see for H5Aclose_async the full API but not have a group to put it into, so it does not show up.

You may need to surround the entire regular API with

#ifndef H5_DOXYGEN

H5_DLL hid_t H5Acreate_async(const char *app_file, const char *app_func, unsigned app_line,
    hid_t loc_id, const char *attr_name, hid_t type_id, hid_t space_id, hid_t acpl_id, hid_t aapl_id,
    hid_t es_id);

#else

H5_DLL hid_t H5Acreate_async(
    hid_t loc_id, const char *attr_name, hid_t type_id, hid_t space_id, hid_t acpl_id, hid_t aapl_id,
    hid_t es_id);

#endif

Otherwise, you'll have two different versions of the API at the same time when H5_DOXYGEN is defined. It would probably also be good just to check what the generated doxygen output looks like.

@byrnHDF
Copy link
Contributor

byrnHDF commented Oct 24, 2022

I think one needs to see the actual result and if it generates any warnings.

@derobins derobins merged commit 7d1997f into HDFGroup:develop Oct 25, 2022
brtnfld added a commit to brtnfld/hdf5 that referenced this pull request Oct 25, 2022
@brtnfld @github-actions
Removed the file, func, line args in the _async APIs fpr doxygen (HDF…
d120328 
…Group#2179)

* Removed the: file, func, line args in the _async APIs from the doxygen arguments. Documented H5ESclean.

* format fixes

* fixed DOXYGEN_PREDEFINED

* Fixed the #ifdet logic for doxygen, added missing multi-dataset va_args

* format fixes

* Use H5_DOXYGEN instead of H5_DOXYGEN_FORTRAN

* reordered multidataset declarations

* alt. for H5Aclose_async and H5Acreate_async

* made doxgyen API into seperate blocks

* updated codespell

* Committing clang-format changes

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jhendersonHDF jhendersonHDF jhendersonHDF left review comments

@fortnern fortnern fortnern left review comments

@byrnHDF byrnHDF byrnHDF approved these changes

@derobins derobins derobins approved these changes

@lrknox lrknox Awaiting requested review from lrknox lrknox is a code owner

@ChristopherHogan ChristopherHogan Awaiting requested review from ChristopherHogan

@qkoziol qkoziol Awaiting requested review from qkoziol qkoziol is a code owner

@vchoi-hdfgroup vchoi-hdfgroup Awaiting requested review from vchoi-hdfgroup vchoi-hdfgroup is a code owner

@bmribler bmribler Awaiting requested review from bmribler bmribler is a code owner

@raylu-hdf raylu-hdf Awaiting requested review from raylu-hdf

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@brtnfld @jhendersonHDF @byrnHDF @derobins @fortnern