Skip to content
Merged
Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
385de52
Fix Doxygen comments showing backslash continuations in macros, fixes…
brtnfld Nov 20, 2025
f43c5f6
Replace "@todo Under Construction" with complete documentation, fixes…
brtnfld Nov 20, 2025
aba01d8
removed code examples
brtnfld Nov 21, 2025
7c9bab5
revisions
brtnfld Nov 21, 2025
502e471
Merge branch 'develop' into 3105
brtnfld Nov 21, 2025
c99173d
fixed tables
brtnfld Nov 21, 2025
9d988c5
docs updates
brtnfld Nov 26, 2025
98c3992
added missing VFDs
brtnfld Nov 26, 2025
409eff9
Committing clang-format changes
github-actions[bot] Nov 26, 2025
a434318
update docs
brtnfld Nov 26, 2025
8e7c960
sp.
brtnfld Nov 26, 2025
ef38168
added to UG TOC
brtnfld Nov 26, 2025
92d1c56
fixed section layer
brtnfld Nov 26, 2025
2aca236
fixed circular dependency issue
brtnfld Nov 26, 2025
44e9c96
fixed missing references
brtnfld Nov 26, 2025
fe5c324
minor updates
brtnfld Nov 27, 2025
601fdc5
Committing clang-format changes
github-actions[bot] Nov 27, 2025
9237c5e
fixed reference
brtnfld Nov 27, 2025
9930911
Merge branch 'develop' into 3105
brtnfld Dec 3, 2025
926f923
fixed sections refereneces
brtnfld Dec 5, 2025
4f828f0
address review comment, addressed warning: expected <tr> or </table> …
brtnfld Dec 5, 2025
b7cd07d
fixed section ref
brtnfld Dec 5, 2025
21ebb4f
Completed "under construction" documentation sections:
brtnfld Dec 5, 2025
b48ca2c
Committing clang-format changes
github-actions[bot] Dec 5, 2025
1aca8c3
Fix grammar in documentation block of H5FDioc.c and improve consistency.
brtnfld Dec 5, 2025
07824a3
rephrased H5Smodule.h documentation
brtnfld Dec 5, 2025
6d47233
Committing clang-format changes
github-actions[bot] Dec 5, 2025
69d17b3
Update src/H5ESmodule.h; missing ',' line 83
lrknox Dec 8, 2025
91e6ec1
Update src/H5ESmodule.h
lrknox Dec 8, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 55 additions & 2 deletions doxygen/dox/UsersGuide.dox
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,15 @@ Navigate back: \ref index "Main"
</ul>
\li \ref subsec_group_examples

\ref H5L_UG
\li \ref subsec_link_intro
\li \ref subsec_link_types
\li \ref subsec_link_create
\li \ref subsec_link_ops
\li \ref subsec_link_traverse
\li \ref subsec_link_user
\li \ref subsec_link_summary

\ref sec_dataset
\li \ref subsec_dataset_intro
\li \ref subsec_dataset_function
Expand Down Expand Up @@ -228,6 +237,25 @@ Navigate back: \ref index "Main"
</ul>
\li \ref subsec_attribute_special

\ref H5O_UG
\li \ref subsec_object_intro
\li \ref subsec_object_ops
\li \ref subsec_object_visit
\li \ref subsec_object_comments
\li \ref subsec_object_refcount
\li \ref subsec_object_cache
\li \ref subsec_object_summary

\ref H5I_UG
\li \ref subsec_identifier_intro
\li \ref subsec_identifier_types
\li \ref subsec_identifier_refcount
\li \ref subsec_identifier_valid
\li \ref subsec_identifier_query
\li \ref subsec_identifier_user
\li \ref subsec_identifier_iteration
\li \ref subsec_identifier_summary

\ref sec_error
\li \ref subsec_error_intro
\li \ref subsec_error_program
Expand Down Expand Up @@ -266,6 +294,17 @@ Navigate back: \ref index "Main"
\li \ref subsec_plist_resources
\li \ref subsec_plist_notes

\ref H5FD_UG
\li \ref subsec_vfd_intro
\li \ref subsec_vfd_purpose
\li \ref subsec_vfd_drivers
\li \ref subsec_vfd_selection
\li \ref subsec_vfd_custom
\li \ref subsec_vfd_parallel
\li \ref subsec_vfd_performance
\li \ref subsec_vfd_query
\li \ref subsec_vfd_summary

\ref sec_vol
\li \ref subsec_vol_intro
\li \ref subsec_vol_abstract_layer
Expand Down Expand Up @@ -337,11 +376,25 @@ Navigate back: \ref index "Main"
\ref sec_async
\li \ref subsec_async_intro

\ref sec_map
\ref H5M_UG
\li \ref subsec_map_intro
\li \ref subsec_map_lifecycle
\li \ref subsec_map_plist
\li \ref subsec_map_datatypes
\li \ref subsec_map_example
\li \ref subsec_map_notes

\ref sec_reference

\ref sec_filter_plugins
\ref H5Z_UG
\li \ref subsec_filter_intro
\li \ref subsec_filter_builtin
\li \ref subsec_filter_usage
\li \ref subsec_filter_pipeline
\li \ref subsec_filter_custom
\li \ref subsec_filter_query
\li \ref subsec_filter_plugins
\li \ref subsec_filter_summary

\section sec_hl HDF5 High Level APIs
\li \ref H5DO_UG
Expand Down
7 changes: 7 additions & 0 deletions hl/src/H5DOpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ extern "C" {
* Navigate back: \ref index "Main" / \ref UG
* <hr>
*
* \section sec_hldo_intro Introduction
*
* The HDF5 Dataset Optimization (H5DO) interface provides high-performance functions for specialized
* dataset I/O operations that bypass standard HDF5 processing layers when appropriate.
*
* @see H5DO Reference Manual
*
* Since version 1.10.3 these functions are deprecated in favor of #H5Dwrite_chunk and #H5Dread_chunk.
*
* \section sec_hldo_direct_chunk Direct Chunk Write Function
Expand Down
41 changes: 10 additions & 31 deletions hl/src/H5DSpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -526,15 +526,11 @@ extern "C" {
*
* These relationships are represented in the file by attributes of the Dataset D and the Dimension
* Scale Datasets. Figure 5 shows the values that are stored for the DIMENSION_LIST attribute of
* Dataset D. This
* <table>
* <tr>
* <td>
* Dataset D.
*
* \image html UML_Attribute.jpg "The UML model for an HDF5 attribute"
* </td>
* </tr>
* </table>
* attribute is a one-dimensional array with the HDF5 datatype variable length
*
* This attribute is a one-dimensional array with the HDF5 datatype variable length
* #H5T_STD_REF_OBJ. Each row of the array is zero or more object references for Dimension Scale datasets.
*
* Table 6 shows the DIMENSION_LABELLIST for Dataset D. This is a one dimensional array with some empty
Expand All @@ -559,30 +555,11 @@ extern "C" {
* an item from the table, because the entries at both ends of the association must be updated
* at the same time.
*
* <table>
* <tr>
* <td>
* \image html H5DS_fig3.png "Figure 3. Example dataset and scales."
* </td>
* </tr>
* </table>
*
* <table>
* <tr>
* <td>
* \image html H5DS_fig4.png "Figure 4. Example labels, names, and attached scales."
* </td>
* </tr>
* </table>
*
* <table>
* <tr>
* <td>
* \image html H5DS_fig5.png "Figure 5. The table of dimension references, stored as an attribute of the
* Dataset."
* </td>
* </tr>
* </table>
* \image html H5DS_fig5.png "Figure 5. The table of dimension references."
*
* <table><caption>Table 6. The table of dimension labels.</caption>
* <tr>
Expand Down Expand Up @@ -750,10 +727,12 @@ extern "C" {
* 3. For each scale, detach the Dimension Scale S from dimension j of Dataset D with H5DSdetach_scale
* 4. Delete the Dataset, with H5Gunlink.
*
* \subsection subsec_dim_scales_api_func Programming API: H5DS
* @see H5DS Reference Manual
* \subsection subsec_dim_scales_ops Dimension Scale Operations
*
* @todo Under Construction
* Attach dimension scales to datasets using #H5DSattach_scale and detach with #H5DSdetach_scale.
* Set and retrieve dimension scale names with #H5DSset_scale and #H5DSget_scale_name. Query
* if a dataset is a dimension scale with #H5DSis_scale and check attachments with #H5DSis_attached.
* Iterate through scales with #H5DSiterate_scales.
*
* Previous Chapter \ref sec_hldo_direct_chunk - Next Chapter \ref sec_hl_images
*
Expand Down
15 changes: 14 additions & 1 deletion hl/src/H5IMpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,20 @@ extern "C" {
*
* \section sec_hl_images HDF5 Images
*
* @todo Under Construction
* \subsection subsec_hl_images_intro Introduction
*
* The HDF5 Image API (H5IM) provides functions for storing and retrieving image data
* in HDF5 files. The API supports common image formats and includes functions for
* working with image attributes such as palettes.
*
* @see H5IM Reference Manual
*
* \subsection subsec_hl_images_ops Image Operations
*
* Create images with #H5IMmake_image_8bit or #H5IMmake_image_24bit, and read them with
* #H5IMread_image. Check if a dataset is an image using #H5IMis_image. Get image
* information with #H5IMget_image_info. Work with palettes using #H5IMmake_palette,
* #H5IMlink_palette, #H5IMget_palette_info, and #H5IMget_palette.
*
* Previous Chapter \ref sec_dim_scales_stand - Next Chapter \ref sec_hl_lite_api
*
Expand Down
25 changes: 24 additions & 1 deletion hl/src/H5LTpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,30 @@ extern "C" {
*
* \section sec_hl_lite_api HDF5 Lite APIs
*
* @todo Under Construction
* \subsection subsec_hl_lite_intro Introduction
*
* The HDF5 Lite API (H5LT) provides simplified functions for common HDF5 operations, combining
* multiple low-level calls into single high-level functions. This reduces code complexity and
* makes HDF5 more accessible for straightforward data storage tasks.
*
* @see H5LT Reference Manual
*
* \subsection subsec_hl_lite_dataset Dataset Operations
*
* Create and access datasets with single function calls using type-specific functions like
* #H5LTmake_dataset_int, #H5LTmake_dataset_float, #H5LTread_dataset_int, etc. Query dataset
* properties with #H5LTget_dataset_ndims, #H5LTget_dataset_info, and #H5LTfind_dataset.
*
* \subsection subsec_hl_lite_attr Attribute Operations
*
* Set and read attributes using type-specific functions such as #H5LTset_attribute_int,
* #H5LTset_attribute_string, #H5LTget_attribute_int, etc. Query attribute information
* with #H5LTget_attribute_ndims and #H5LTget_attribute_info.
*
* \subsection subsec_hl_lite_util Utility Functions
*
* Convert between datatypes and text representations using #H5LTtext_to_dtype and #H5LTdtype_to_text.
* Validate paths with #H5LTpath_valid, and work with file images using #H5LTopen_file_image.
*
* Previous Chapter \ref sec_hl_images - Next Chapter \ref sec_hl_table_api
*
Expand Down
16 changes: 14 additions & 2 deletions hl/src/H5PTpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,21 @@ extern "C" {
* Navigate back: \ref index "Main" / \ref UG
* <hr>
*
* \section sec_hl_packet_table_api HDF5 Table APIs
* \section sec_hl_packet_table_api HDF5 Packet Table APIs
*
* @todo Under Construction
* \subsection subsec_hl_packet_intro Introduction
*
* The HDF5 Packet Table API (H5PT) provides an interface for storing and retrieving
* fixed-length packets of data in append-only datasets. Packet tables are optimized
* for streaming data collection where records are added sequentially.
*
* @see H5PT Reference Manual
*
* \subsection subsec_hl_packet_ops Packet Table Operations
*
* Create packet tables with #H5PTcreate or open existing ones with #H5PTopen. Append
* packets using #H5PTappend and read packets with #H5PTread_packets. Get the number
* of packets with #H5PTget_num_packets. Close with #H5PTclose.
*
* Previous Chapter \ref sec_hl_table_api
*
Expand Down
15 changes: 14 additions & 1 deletion hl/src/H5TBpublic.h
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,20 @@ extern "C" {
*
* \section sec_hl_table_api HDF5 Table APIs
*
* @todo Under Construction
* \subsection subsec_hl_table_intro Introduction
*
* The HDF5 Table API (H5TB) provides functions for creating and manipulating HDF5 datasets
* as tables with named fields, similar to database tables or spreadsheets. Tables organize
* data in rows and columns, making them ideal for storing structured records.
*
* @see H5TB Reference Manual
*
* \subsection subsec_hl_table_ops Table Operations
*
* Create tables with #H5TBmake_table, append rows with #H5TBappend_records, write data with
* #H5TBwrite_records, and read with #H5TBread_records. Insert or delete records using
* #H5TBinsert_record and #H5TBdelete_record. Add or delete fields with #H5TBinsert_field
* and #H5TBdelete_field. Query table properties with #H5TBget_table_info and #H5TBget_field_info.
*
* Previous Chapter \ref sec_hl_lite_api - Next Chapter \ref sec_hl_packet_table_api
*
Expand Down
9 changes: 4 additions & 5 deletions src/H5ESmodule.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,9 +30,8 @@
* Navigate back: \ref index "Main" / \ref UG
* <hr>
*
* @todo Under Construction
*
* \section sec_async The HDF5 Event Set Interface
* \subsection subsec_async_overview Overview
*
* \section subsec_async_intro Introduction
* HDF5 provides asynchronous APIs for the HDF5 VOL connectors that support asynchronous HDF5
Expand All @@ -51,7 +50,7 @@
* </tr>
* <tr>
* <th>H5F</th>
* <td>#H5Fcreate, #H5Fflush, #H5Fis_accessible, #H5Fopen, #H5Fclose
* <td>#H5Fcreate, #H5Fflush, #H5Fopen, #H5Fclose
* </td>
* </tr>
* <tr>
Expand Down Expand Up @@ -82,7 +81,7 @@
* </tr>
* <tr>
* <th>H5R</th>
* <td>#H5Ropen_attr, #H5Ropen_object #H5Ropen_region, #H5Rdereference
* <td>#H5Ropen_attr, #H5Ropen_object #H5Ropen_region
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
* <td>#H5Ropen_attr, #H5Ropen_object #H5Ropen_region
* <td>#H5Ropen_attr, #H5Ropen_object #H5Ropen_region,

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

comma should be after #H5Ropen_object

* </td>
* </tr>
* <tr>
Expand All @@ -92,7 +91,7 @@
* </tr>
* <tr>
* <th>H5T</th>
* <td>#H5Tcommit, #H5Topen, #H5Tcopy, #H5Tclose
* <td>#H5Tcommit, #H5Topen, #H5Tclose
* </td>
* </tr>
* </table>
Expand Down
Loading
Loading