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

Add tools to doxygen #2875

Open
byrnHDF opened this issue May 2, 2023 · 2 comments
Open

Add tools to doxygen #2875

byrnHDF opened this issue May 2, 2023 · 2 comments
Assignees
@byrnHDF
Labels
Component - Tools Command-line tools like h5dump, includes high-level tools Priority - 1. High 🔼 These are important issues that should be resolved in the next release Type - Improvement Improvements that don't add a new feature or functionality

Comments

@byrnHDF
Copy link
Contributor

byrnHDF commented May 2, 2023

The tools library API has remained stable for quite some time, with additions as new features are available in the hdf5 library. Also the tools do interact with environment variables that may not be documented anywhere.
There is an outstanding issue, #1761, that would be resolved with doxygen pages.
@byrnHDF
Copy link
Contributor Author

byrnHDF commented May 2, 2023

Existing documentation: https://portal.hdfgroup.org/display/HDF5/Tools

@byrnHDF byrnHDF self-assigned this May 2, 2023
@derobins derobins added Priority - 1. High 🔼 These are important issues that should be resolved in the next release Component - Tools Command-line tools like h5dump, includes high-level tools Type - Improvement Improvements that don't add a new feature or functionality labels May 2, 2023
@byrnHDF
Copy link
Contributor Author

byrnHDF commented Jun 24, 2024

See PR #4602

@byrnHDF byrnHDF mentioned this issue Jun 24, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@byrnHDF byrnHDF

Labels
Component - Tools Command-line tools like h5dump, includes high-level tools Priority - 1. High 🔼 These are important issues that should be resolved in the next release Type - Improvement Improvements that don't add a new feature or functionality
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@derobins @byrnHDF