Fix javadoc errors - #6504
Conversation
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>
Review ChecklistThis PR touches the following areas. Each needs a sign-off
|
| * <B>Do not edit this file!</b> | ||
| * | ||
| * @see @ref HDF5LIB | ||
| * @ref HDF5LIB |
There was a problem hiding this comment.
@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.
| @@ -19309,7 +19302,7 @@ public static String H5Rget_attr_name(byte[] ref_ptr) | |||
| * | |||
| * @see H5S, C-API | |||
There was a problem hiding this comment.
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.
|
Opened a follow-up PR against this branch addressing the two open review comments (from @jhendersonHDF and @mattjala on the Feel free to merge that in whenever convenient. |
|
Thanks @mkitti! For example in * <P>
* @ref HDFARRAY.
*/ |
5 participants
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.