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

Translate release-specific changes docs to doxygen #5314

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from

Conversation

byrnHDF
Copy link
Contributor

@byrnHDF byrnHDF commented Feb 12, 2025

Release-specific files from HDFGroup. github.io doc repo converted to doxygen.
Changed all refs to tools to be links.

@byrnHDF byrnHDF added Priority - 2. Medium ⏹ It would be nice to have this in the next release Component - Documentation Doxygen, markdown, etc. Type - Improvement Improvements that don't add a new feature or functionality labels Feb 12, 2025
@byrnHDF byrnHDF self-assigned this Feb 12, 2025
These functions enable the user to specify the locations of external files.
(These functions are not yet documented.)

H5Pget_elink_prefix
Copy link
Contributor

Choose a reason for hiding this comment

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

This one has a link, so line 525 should be removed.

Copy link
Contributor Author

@byrnHDF byrnHDF Feb 13, 2025

Choose a reason for hiding this comment

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

No that line probably should just add a "as of version x.y.z"

\li \ref subsec_rel_spec_110_change_1versus0
\li \ref subsec_rel_spec_110_change_0versus8_16

See [API Compatibility Reports for 1.10]() for information regarding compatibility with previous releases.
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't have this page any more. Line 29 should be removed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am going to resolve the compat reports in a separate PR. Unless some one has a major issue with it. Because we need to make sure the support site is properly updated and doxygen can access the files.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Resolved the 1.14 with an update

Co-authored-by: Larry Knox <lrknox@hdfgroup.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Documentation Doxygen, markdown, etc. Priority - 2. Medium ⏹ It would be nice to have this in the next release Type - Improvement Improvements that don't add a new feature or functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants