diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2023-03-01 01:08:47 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-03-01 01:08:47 (GMT) |
commit | 91cf10156a65a96860cea965df74a5adecf3e4e8 (patch) | |
tree | 5466ea669b3c26ad27ad1b82d3bf4287df70a175 /doxygen/examples/menus | |
parent | 4e645aeedf621b341c6b6d5665fecdd08314bda9 (diff) | |
download | hdf5-91cf10156a65a96860cea965df74a5adecf3e4e8.zip hdf5-91cf10156a65a96860cea965df74a5adecf3e4e8.tar.gz hdf5-91cf10156a65a96860cea965df74a5adecf3e4e8.tar.bz2 |
1.12 Merge doxygen plist tables changes #2470 from develop (#2505)
* Merge doxygen plist tables changes #2470 from develop
* Add new/moved files
* More add new/moved files
* Doxy corrections
Diffstat (limited to 'doxygen/examples/menus')
-rw-r--r-- | doxygen/examples/menus/core_menu.md | 69 | ||||
-rw-r--r-- | doxygen/examples/menus/fortran_menu.md | 73 | ||||
-rw-r--r-- | doxygen/examples/menus/high_level_menu.md | 30 | ||||
-rw-r--r-- | doxygen/examples/menus/java_menu.md | 84 |
4 files changed, 256 insertions, 0 deletions
diff --git a/doxygen/examples/menus/core_menu.md b/doxygen/examples/menus/core_menu.md new file mode 100644 index 0000000..3fd7d11 --- /dev/null +++ b/doxygen/examples/menus/core_menu.md @@ -0,0 +1,69 @@ +<b>Core Library</b> + +- @ref H5A "Attributes (H5A)" +<br /> +HDF5 attribute is a small metadata object describing the nature and/or intended usage of a primary data object. + +- @ref H5D "Datasets (H5D)" +<br /> +Manage HDF5 datasets, including the transfer of data between memory and disk and the description of dataset properties. + +- @ref H5S "Dataspaces (H5S)" +<br /> +HDF5 dataspaces describe the shape of datasets in memory or in HDF5 files. + +- @ref H5T "Datatypes (H5T)" +<br /> +HDF5 datatypes describe the element type of HDF5 datasets and attributes. + +- @ref H5E "Error Handling (H5E)" +<br /> +HDF5 library error reporting. + +- @ref H5ES "Event Set (H5ES)" +<br /> +HDF5 event set life cycle used with HDF5 VOL connectors that enable the asynchronous feature in HDF5. + +- @ref H5F "Files (H5F)" +<br /> +Manage HDF5 files. + +- @ref H5Z "Filters (H5Z)" +<br /> +Manage HDF5 user-defined filters + +- @ref H5G "Groups (H5G)" +<br /> +Manage HDF5 groups. + +- @ref H5I "Identifiers (H5I)" +<br /> +Manage identifiers defined by the HDF5 library. + +- @ref H5 "Library General (H5)" +<br /> +Manage the life cycle of HDF5 library instances. + +- @ref H5L "Links (H5L)" +<br /> +Manage HDF5 links and link types. + +- @ref H5O "Objects (H5O)" +<br /> +Manage HDF5 objects (groups, datasets, datatype objects). + +- @ref H5P "Property Lists (H5P)" +<br /> +HDF5 property lists are the main vehicle to configure the behavior of HDF5 API functions. + +- @ref H5PL "Dynamically-loaded Plugins (H5PL)" +<br /> +Manage the loading behavior of HDF5 plugins. + +- @ref H5R "References (H5R)" +<br /> +Manage HDF5 references (HDF5 objects, attributes, and selections on datasets a.k.a. dataset regions). + +- @ref H5VL "VOL Connector (H5VL)" +<br /> +Manage HDF5 VOL connector plugins. diff --git a/doxygen/examples/menus/fortran_menu.md b/doxygen/examples/menus/fortran_menu.md new file mode 100644 index 0000000..8ef4ead --- /dev/null +++ b/doxygen/examples/menus/fortran_menu.md @@ -0,0 +1,73 @@ +<b>Fortran Library</b> + +- @ref FH5A "Attributes (H5A)" +<br /> +HDF5 attribute is a small metadata object describing the nature and/or intended usage of a primary data object. + +- @ref FH5D "Datasets (H5D)" +<br /> +Manage HDF5 datasets, including the transfer of data between memory and disk and the description of dataset properties. + +- @ref FH5S "Dataspaces (H5S)" +<br /> +HDF5 dataspaces describe the shape of datasets in memory or in HDF5 files. + +- @ref FH5T "Datatypes (H5T)" +<br /> +HDF5 datatypes describe the element type of HDF5 datasets and attributes. + +- @ref FH5E "Error Handling (H5E)" +<br /> +HDF5 library error reporting. + +- @ref FH5F "Files (H5F)" +<br /> +Manage HDF5 files. + +- @ref FH5Z "Filters (H5Z)" +<br /> +Manage HDF5 user-defined filters + +- @ref FH5G "Groups (H5G)" +<br /> +Manage HDF5 groups. + +- @ref FH5I "Identifiers (H5I)" +<br /> +Manage identifiers defined by the HDF5 library. + +- @ref FH5 "Library General (H5)" +<br /> +Manage the life cycle of HDF5 library instances. + +- @ref FH5L "Links (H5L)" +<br /> +Manage HDF5 links and link types. + +- @ref FH5O "Objects (H5O)" +<br /> +Manage HDF5 objects (groups, datasets, datatype objects). + +- @ref FH5P "Property Lists (H5P)" +<br /> +HDF5 property lists are the main vehicle to configure the behavior of HDF5 API functions. + +- @ref FH5R "References (H5R)" +<br /> +Manage HDF5 references (HDF5 objects, attributes, and selections on datasets a.k.a. dataset regions). + +- @ref FH5LT "High Level Lite (H5LT)" +<br /> +Functions to simplify creating and manipulating datasets, attributes and other features + +- @ref FH5IM "High Level Image (H5IM)" +<br /> +Creating and manipulating HDF5 datasets intended to be interpreted as images + +- @ref FH5TB "High Level Table (H5TB)" +<br /> +Creating and manipulating HDF5 datasets intended to be interpreted as tables + +- @ref FH5DS "High Level Dimension Scale (H5DS)" +<br /> +Creating and manipulating HDF5 datasets that are associated with the dimension of another HDF5 dataset diff --git a/doxygen/examples/menus/high_level_menu.md b/doxygen/examples/menus/high_level_menu.md new file mode 100644 index 0000000..d209bf4 --- /dev/null +++ b/doxygen/examples/menus/high_level_menu.md @@ -0,0 +1,30 @@ +<b>High-level library</b> +<br /> +The high-level HDF5 library includes several sets of convenience and standard-use APIs to +facilitate common HDF5 operations. + +- @ref H5LT +<br /> +Functions to simplify creating and manipulating datasets, attributes and other features + +- @ref H5IM +<br /> +Creating and manipulating HDF5 datasets intended to be interpreted as images + +- @ref H5TB +<br /> +Creating and manipulating HDF5 datasets intended to be interpreted as tables + +- @ref H5PT +<br /> +Creating and manipulating HDF5 datasets to support append- and read-only operations on table data + +- @ref H5DS +<br /> +Creating and manipulating HDF5 datasets that are associated with the dimension of another HDF5 dataset + +- @ref H5DO +<br /> +Bypassing default HDF5 behavior in order to optimize for specific use cases + +- @ref H5LR "Extensions (H5LR, H5LT)" diff --git a/doxygen/examples/menus/java_menu.md b/doxygen/examples/menus/java_menu.md new file mode 100644 index 0000000..1236838 --- /dev/null +++ b/doxygen/examples/menus/java_menu.md @@ -0,0 +1,84 @@ +<b>Java Library</b> + @ref HDF5LIB + +- @ref JH5 +<br /> +This package is the Java interface for the HDF5 library. + +- @ref JH5A +<br /> +This package is the Java interface for the HDF5 library attribute APIs. + +- @ref JH5D +<br /> +This package is the Java interface for the HDF5 library dataset APIs. + +- @ref JH5S +<br /> +This package is the Java interface for the HDF5 library dataspace APIs. + +- @ref JH5T +<br /> +This package is the Java interface for the HDF5 library datatype APIs. + +- @ref JH5E +<br /> +This package is the Java interface for the HDF5 library error APIs. + +- @ref JH5F +<br /> +This package is the Java interface for the HDF5 library file APIs. + +- @ref JH5Z +<br /> +This package is the Java interface for the HDF5 library filter APIs. + +- @ref JH5G +<br /> +This package is the Java interface for the HDF5 library group APIs. + +- @ref JH5I +<br /> +This package is the Java interface for the HDF5 library identifier APIs. + +- @ref JH5L +<br /> +This package is the Java interface for the HDF5 library links APIs. + +- @ref JH5O +<br /> +This package is the Java interface for the HDF5 library object APIs. + +- @ref JH5P +<br /> +This package is the Java interface for the HDF5 library property list APIs. + +- @ref JH5PL +<br /> +This package is the Java interface for the HDF5 library plugin APIs. + +- @ref JH5R +<br /> +This package is the Java interface for the HDF5 library reference APIs. + +- @ref JH5VL +<br /> +This package is the Java interface for the HDF5 library VOL connector APIs. + +- @ref HDF5CONST +<br /> +This class contains C constants and enumerated types of HDF5 library. + +- @ref HDFNATIVE +<br /> +This class encapsulates native methods to deal with arrays of numbers, + * converting from numbers to bytes and bytes to numbers. + +- @ref HDFARRAY +<br /> +This is a class for handling multidimensional arrays for HDF. + +- @ref ERRORS +<br /> +The class HDF5Exception returns errors from the Java HDF5 Interface. +
\ No newline at end of file |