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

Merge doxygen2 into develop #553

Merged
merged 102 commits into from
Apr 26, 2021
Merged

Merge doxygen2 into develop #553

merged 102 commits into from
Apr 26, 2021

Conversation

gheber
Copy link
Member

@gheber gheber commented Apr 19, 2021

This PR contains the full (?) Doxygen-based RM. The current doxygen-2 branch is no longer necessary (it's become an impediment) and all future changes should go straight to develop.

gheber and others added 30 commits February 5, 2021 20:01
* H5Eauto_is_v2.

* Added a few more calls.

* Added a few more H5E calls.

* First cut of H5E v2.

* Added the deprecated v1 calls.

* Updated spacing.

* Once more.
#352)

* Add doxygen for the assigned functions: H5Pregister1,H5Pinsert1,H5Pencode1, H5Pget_filter_by_id1,H5Pget_version, H5Pset_file_space,H5Pget_file_space. Someone already adds H5Pget_filter1. Also fixs an extra parameter 'close' call back function for HPregister2.

* doxygen work. fixs format by using clang-format.

* doxgen work for H5Pregister1 etc. Addressed Barbara and Gerd's comments.
For Quincey's comments, since we are not supposed to change the source code.
I leave this to future improvements.
* add documenation for H5Pget_buffer,H5Pget_data_transform,H5Pget_edc_check,H5Pget_hyper_vector_size,H5Pget_preserve,H5Pget_type_conv_cb,H5Pget_vlen_mem_manager,H5Pset_btree_ratios

* format corrections

* fixed grammer

* fixed herr_t
* Add doxygen comments in H5Ppublic.h

* H5Pset_meta_block_size
* H5Pset_metadata_read_attempts
* H5Pset_multi_type
* H5Pset_object_flush_cb
* H5Pset_sieve_buf_size
* H5Pset_small_data_block_size
* H5Pset_all_coll_metadata_ops
* H5Pget_all_coll_metadata_ops

* Add DOXYGEN_EXAMPLES_DIR to src/CMakeLists.txt

* Fix clang-format errors

* Fix filenames in doxygen/examples
* add doxygen to H5Ppublic.h

* use attention instead of warning

Co-authored-by: Kimmy Mu <kmu@hdfgroup.org>
Revert "add doxygen to H5Ppublic.h"
src/H5Ppublic.h Outdated Show resolved Hide resolved
src/H5Ppublic.h Outdated Show resolved Hide resolved
src/H5Ppublic.h Outdated Show resolved Hide resolved
src/H5Ppublic.h Outdated Show resolved Hide resolved
src/H5Ppublic.h Outdated Show resolved Hide resolved
src/H5Ppublic.h Outdated Show resolved Hide resolved
src/H5Ppublic.h Outdated Show resolved Hide resolved
@gheber gheber self-assigned this Apr 19, 2021
@gheber gheber added this to the HDF5 1.12.1 release milestone Apr 19, 2021
Copy link

@epourmal epourmal left a comment

Choose a reason for hiding this comment

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

Please add a record to the RELEASE.txt file (Documentation section) about the new feature and how to enable it.
Thank you!

@lrknox lrknox merged commit 1d680fe into HDFGroup:develop Apr 26, 2021
@gheber gheber deleted the doxygen2 branch April 26, 2021 20:59
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.

9 participants