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.

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

Add my assigned Doxygen documentation. #407

Merged
merged 3 commits into from
Mar 12, 2021
Merged

Conversation

gnuoyd
Copy link
Contributor

@gnuoyd gnuoyd commented Mar 1, 2021

No description provided.

Copy link
Member

@gheber gheber left a comment

Choose a reason for hiding this comment

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

I'm not sure what clang is bitching about, but the Doxygen comments look great.

@lrknox
Copy link
Collaborator

lrknox commented Mar 5, 2021

These are the changes clang wants, according to clang-format Check/Details:

--- ./doxygen/examples/H5Pget_object_flush_cb.c (original)
+++ ./doxygen/examples/H5Pget_object_flush_cb.c (reformatted)
@@ -1,7 +1,7 @@
-hid_t fapl_id;
-unsigned counter;
+hid_t fapl_id;
+unsigned counter;
H5F_object_flush_t *ret_cb;
-unsigned *ret_counter;
+unsigned * ret_counter;

/* Create a copy of the file access property list */
fapl_id = H5Pcreate(H5P_FILE_ACCESS);
--- ./src/H5Ppublic.h (original)
+++ ./src/H5Ppublic.h (reformatted)
@@ -3688,8 +3688,7 @@
*

  • \since 1.10.1
    */
    -H5_DLL herr_t H5Pget_page_buffer_size(hid_t plist_id, size_t *buf_size,
  •                                  unsigned *min_meta_perc,
    

+H5_DLL herr_t H5Pget_page_buffer_size(hid_t plist_id, size_t *buf_size, unsigned min_meta_perc,
unsigned min_raw_perc);
/

  • \ingroup FAPL

I can easily run format_source if you want me to do it.

@gnuoyd
Copy link
Contributor Author

gnuoyd commented Mar 10, 2021

@lrknox Sure, you should go ahead and apply the format changes if it's easy.

@gheber gheber merged commit 48ad87c into HDFGroup:doxygen2 Mar 12, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants