Conversation
- Convert remaining @see H5S/H5T/H5VL/H5Z, C-API tags to @ref for consistency with every other @defgroup interface block in H5.java (per mattjala's review comment). - Restore the Doxygen "See Also" reference in HDF5Constants.java by using "See also @ref HDF5LIB" instead of a bare @ref, matching the convention already used elsewhere in this PR (package-info.java, HDFArray.java) for prose-based @see @ref conversions (per jhendersonHDF's review comment).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up fixes for the two open review comments on HDFGroup#6504.
Changes
java/hdf/hdf5lib/H5.java— mattjala's comment noted that the@defgroupblocks for H5S, H5T, H5VL, and H5Z were the only ones left using@see H5x, C-APIwhile every other interface in the file (and even the already-convertedjava/src-jni/hdf/hdf5lib/H5.javamirror) uses@ref H5x, C-API. Converted all four for consistency.java/hdf/hdf5lib/HDF5Constants.javaandjava/src-jni/hdf/hdf5lib/HDF5Constants.java— jhendersonHDF's comment pointed out that dropping@seefrom@see @ref HDF5LIB(to fix the javadoc build) also drops the "See Also" entry Doxygen renders on the published docs page. This PR already uses a Javadoc-safe way to preserve that semantic elsewhere (package-info.java's@see @ref ERRORS.→See also @ref ERRORS., andHDFArray.java's similar rewrite), so I applied the sameSee also @ref HDF5LIBpattern here instead of the bare@ref.Test plan