Skip to content

Fix javadoc errors - #6504

Open
matteodg wants to merge 12 commits into
HDFGroup:developfrom
matteodg:fix-javadoc-errors
Open

Fix javadoc errors#6504
matteodg wants to merge 12 commits into
HDFGroup:developfrom
matteodg:fix-javadoc-errors

Conversation

@matteodg

@matteodg matteodg commented Jul 4, 2026

Copy link
Copy Markdown

The branch tries to resolve at least the javadoc errors (there are also a lot of warnings, but not addressed in this branch).
This helps the GitHub builds to pass.

matteodg and others added 12 commits July 4, 2026 22:13
@matteodg
docs(java): fix javadoc error on H5Fcreate flags HTML list parsing
94a0365
@matteodg
docs(java): fix javadoc error on native signatures
f090f9b
@matteodg
docs(java): fix javadoc error "@see" to "see also"
2e2e78b
@matteodg
docs(java): fix javadoc error @see wrapping bold @ref H5E
868f2e9
@matteodg
docs(java): fix javadoc error @see before "H5x_UG, User Guide" refere…
d3f478c 
…nces
@matteodg
docs(java): fix javadoc error @see before "H5x, C-API" references
00bbb34
@matteodg
docs(java): fix javadoc error @see before HDF5LIB
a2dc041
@matteodg
docs(java): fix javadoc error @see before HDFARRAY
6fcc2f8
@matteodg
docs(java): fix javadoc error package-info HTML and comment formatting
563b96a
@matteodg
docs(java): fix doxygen @ref HDFNATIVE
2fb089c
@matteodg
docs(java): fix javadoc error self-closing element not allowed
6a5ff14
@matteodg @cursoragent
docs(java): align FFM javadoc @PARAM names with method signatures
7b94f19 
Update callback interface and struct constructor documentation to match FFM
apply() parameter names after the bindings were regenerated from jextract.

Co-authored-by: Cursor <cursoragent@cursor.com>
@github-project-automation github-project-automation Bot moved this to To be triaged in HDF5 - TRIAGE & TRACK Jul 4, 2026
@github-actions

github-actions Bot commented Jul 4, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review Checklist

This PR touches the following areas. Each needs a sign-off
from its listed owners before merging.

  • java

@github-actions
github-actions Bot removed the request for review from jhendersonHDF July 4, 2026 20:17
This was referenced Jul 4, 2026
Open
Open
@vchoi-hdfgroup vchoi-hdfgroup added the Component - Wrappers C++, Java & Fortran wrappers label Jul 6, 2026
jhendersonHDF
jhendersonHDF reviewed Jul 10, 2026
View reviewed changes
Comment thread java/hdf/hdf5lib/HDF5Constants.java
* <B>Do not edit this file!</b>
*
* @see @ref HDF5LIB
* @ref HDF5LIB

@jhendersonHDF jhendersonHDF Jul 10, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@matteodg I believe the reason @see @ref ref is used here is because this is intended to be for Doxygen and not javadoc, so this change would remove the "See also" at https://support.hdfgroup.org/documentation/hdf5/latest/_h_d_f5_c_o_n_s_t.html. That's a very minor change that wouldn't affect much, but I think it brings up the point that we have to consider how to make the two work together.

mattjala
mattjala reviewed Jul 10, 2026
View reviewed changes
Comment thread java/hdf/hdf5lib/H5.java
@@ -19309,7 +19302,7 @@ public static String H5Rget_attr_name(byte[] ref_ptr)
*
* @see H5S, C-API

@mattjala mattjala Jul 10, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The @defgroup headers for H5S, H5T, H5VL, and H5Z still use @see H5S, C-API [...], while every other interface here was converted to @ref. These should be updated to to @ref H5x, C-API [...] for consistency.

@mkitti mkitti mentioned this pull request Jul 23, 2026
Open
2 tasks
@mkitti

mkitti commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Opened a follow-up PR against this branch addressing the two open review comments (from @jhendersonHDF and @mattjala on the @see/@ref conversions): matteodg#2

Feel free to merge that in whenever convenient.

@matteodg

matteodg commented Jul 30, 2026

Copy link
Copy Markdown
Author

Thanks @mkitti!
Sorry for the delay: I'm reviewing the whole branch and there are other places where I removed the @see and kept only @ref, I guess I should add "See also" before @ref there as well, right?

For example in java/src-jni/hdf/hdf5lib/HDFNativeData.java:32-34:

 * <P>
 * @ref HDFARRAY.
 */

@hyoklee hyoklee added this to the Backlog milestone Aug 28, 2026
@github-actions github-actions Bot added the stale label Aug 30, 2026
@github-actions

github-actions Bot commented Aug 30, 2026

Copy link
Copy Markdown
Contributor

This pull request has had no activity for 30 days and has been marked stale. Push a commit or comment to keep it open, or it will be flagged for maintainer review.

@github-actions github-actions Bot added the needs-decision Stale past the alert threshold -- needs a maintainer decision to keep open or close label Sep 13, 2026
@github-actions

github-actions Bot commented Sep 13, 2026

Copy link
Copy Markdown
Contributor

@jhendersonHDF this has been marked stale for 14+ days with no qualifying activity. Could you decide whether to keep it open or close it? Removing the stale label will reset this check.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jhendersonHDF jhendersonHDF jhendersonHDF left review comments
@mattjala mattjala mattjala left review comments

At least 1 approving review is required to merge this pull request.

Assignees

@jhendersonHDF jhendersonHDF

Labels

Component - Wrappers C++, Java & Fortran wrappers needs-decision Stale past the alert threshold -- needs a maintainer decision to keep open or close stale

Projects

HDF5 - TRIAGE & TRACK
Status: To be triaged

Milestone

HDF5 Backlog

Development

Successfully merging this pull request may close these issues.

6 participants

@matteodg @mkitti @jhendersonHDF @mattjala @hyoklee @vchoi-hdfgroup