diff options
author | Allen Byrne <50328838+byrnHDF@users.noreply.github.com> | 2022-09-27 03:49:29 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-09-27 03:49:29 (GMT) |
commit | dcd332d2310d3f402a01ebfc187dc36101662d71 (patch) | |
tree | 14867bede382c140250b5a55486c9cad8afbfa8f /doxygen/dox | |
parent | 853a592d2db514f1403b4eab4ee6be2c0ed93da6 (diff) | |
download | hdf5-dcd332d2310d3f402a01ebfc187dc36101662d71.zip hdf5-dcd332d2310d3f402a01ebfc187dc36101662d71.tar.gz hdf5-dcd332d2310d3f402a01ebfc187dc36101662d71.tar.bz2 |
Restructure ref manual presentation (#2123)
Diffstat (limited to 'doxygen/dox')
-rw-r--r-- | doxygen/dox/PredefinedDatatypeTables.dox | 22 | ||||
-rw-r--r-- | doxygen/dox/RFC.dox | 196 | ||||
-rw-r--r-- | doxygen/dox/ReferenceManual.dox | 139 |
3 files changed, 245 insertions, 112 deletions
diff --git a/doxygen/dox/PredefinedDatatypeTables.dox b/doxygen/dox/PredefinedDatatypeTables.dox new file mode 100644 index 0000000..fbafa94 --- /dev/null +++ b/doxygen/dox/PredefinedDatatypeTables.dox @@ -0,0 +1,22 @@ +/** \page predefined_datatypes_tables HDF5 Predefined Datatypes + * + * The following datatypes are predefined in HDF5. + * + * \snippet{doc} tables/predefinedDatatypes.dox predefined_ieee_datatypes_table + * + * \snippet{doc} tables/predefinedDatatypes.dox predefined_std_datatypes_table + * + * \snippet{doc} tables/predefinedDatatypes.dox predefined_unix_datatypes_table + * + * \snippet{doc} tables/predefinedDatatypes.dox predefined_string_datatypes_table + * + * \snippet{doc} tables/predefinedDatatypes.dox predefined_intel_datatypes_table + * + * \snippet{doc} tables/predefinedDatatypes.dox predefined_dec_datatypes_table + * + * \snippet{doc} tables/predefinedDatatypes.dox predefined_mips_datatypes_table + * + * \snippet{doc} tables/predefinedDatatypes.dox predefined_native_datatypes_table + * + * \snippet{doc} tables/predefinedDatatypes.dox predefined_c9x_datatypes_table + */ diff --git a/doxygen/dox/RFC.dox b/doxygen/dox/RFC.dox index 134a221..1b1141b 100644 --- a/doxygen/dox/RFC.dox +++ b/doxygen/dox/RFC.dox @@ -1,104 +1,104 @@ /** \page RFC RFCs <table> -<tr><th>RFC ID</th><th>Title</th><th>Comments</th></tr> -<tr> <td>2022-08-19</td> <td>\ref_rfc20220819</td> <td></td></tr> -<tr> <td>2021-05-28</td> <td>\ref_rfc20210528</td> <td></td></tr> -<tr> <td>2021-02-19</td> <td>\ref_rfc20210219</td> <td></td></tr> -<tr> <td>2020-02-13</td> <td>\ref_rfc20200213</td> <td></td></tr> -<tr> <td>2020-02-10</td> <td>\ref_rfc20200210</td> <td></td></tr> -<tr> <td>2019-09-23</td> <td>\ref_rfc20190923</td> <td></td></tr> -<tr> <td>2019-07-15</td> <td>\ref_rfc20190715</td> <td></td> </tr> -<tr> <td>2019-04-10</td> <td>\ref_rfc20190410</td> <td></td> </tr> -<tr> <td>2018-12-31</td> <td>\ref_rfc20181231</td> <td></td> </tr> -<tr> <td>2018-12-20</td> <td>\ref_rfc20181220</td> <td></td> </tr> -<tr> <td>2018-08-30</td> <td>\ref_rfc20180830</td> <td></td> </tr> -<tr> <td>2018-08-29</td> <td>\ref_rfc20180829</td> <td></td> </tr> -<tr> <td>2018-08-15</td> <td>\ref_rfc20180815</td> <td></td> </tr> -<tr> <td>2018-07-12</td> <td>\ref_rfc20180712</td> <td></td> </tr> -<tr> <td>2018-06-20</td> <td>\ref_rfc20180620</td> <td></td> </tr> -<tr> <td>2018-06-10</td> <td>\ref_rfc20180610</td> <td></td> </tr> -<tr> <td>2018-03-21</td> <td>\ref_rfc20180321</td> <td></td> </tr> -<tr> <td>2018-01-25</td> <td>\ref_rfc20180125</td> <td></td> </tr> -<tr> <td>2017-07-07</td> <td>\ref_rfc20170707</td> <td></td> </tr> -<tr> <td>2016-01-05</td> <td>\ref_rfc20160105</td> <td></td> </tr> -<tr> <td>2015-09-15</td> <td>\ref_rfc20150915</td> <td></td> </tr> -<tr> <td>2015-07-09</td> <td>\ref_rfc20150709</td> <td></td> </tr> -<tr> <td>2015-06-15</td> <td>\ref_rfc20150615</td> <td></td> </tr> -<tr> <td>2015-04-29</td> <td>\ref_rfc20150429</td> <td></td> </tr> -<tr> <td>2015-04-24</td> <td>\ref_rfc20150424</td> <td></td> </tr> -<tr> <td>2015-04-23</td> <td>\ref_rfc20150423</td> <td></td> </tr> -<tr> <td>2015-03-01</td> <td>\ref_rfc20150301</td> <td></td> </tr> -<tr> <td>2015-02-12</td> <td>\ref_rfc20150212</td> <td></td> </tr> -<tr> <td>2015-02-05</td> <td>\ref_rfc20150205</td> <td></td> </tr> -<tr> <td>2015-02-02</td> <td>\ref_rfc20150202</td> <td></td> </tr> -<tr> <td>2014-12-10</td> <td>\ref_rfc20141210</td> <td></td> </tr> -<tr> <td>2014-12-01</td> <td>\ref_rfc20141201</td> <td></td> </tr> -<tr> <td>2014-09-16</td> <td>\ref_rfc20140916</td> <td></td> </tr> -<tr> <td>2014-08-27</td> <td>\ref_rfc20140827</td> <td></td> </tr> -<tr> <td>2014-07-29</td> <td>\ref_rfc20140729</td> <td></td> </tr> -<tr> <td>2014-07-22</td> <td>\ref_rfc20140722</td> <td></td> </tr> -<tr> <td>2014-07-17</td> <td>\ref_rfc20140717</td> <td></td> </tr> -<tr> <td>2014-07-07</td> <td>\ref_rfc20140707</td> <td></td> </tr> -<tr> <td>2014-05-24</td> <td>\ref_rfc20140524</td> <td></td> </tr> -<tr> <td>2014-03-18</td> <td>\ref_rfc20140318</td> <td></td> </tr> -<tr> <td>2014-03-13</td> <td>\ref_rfc20140313</td> <td></td> </tr> -<tr> <td>2014-02-24</td> <td>\ref_rfc20140224</td> <td></td> </tr> -<tr> <td>2013-12-11</td> <td>\ref_rfc20131211</td> <td></td> </tr> -<tr> <td>2013-09-30</td> <td>\ref_rfc20130930</td> <td></td> </tr> -<tr> <td>2013-09-19</td> <td>\ref_rfc20130919</td> <td></td> </tr> -<tr> <td>2013-06-30</td> <td>\ref_rfc20130630</td> <td></td> </tr> -<tr> <td>2013-03-16</td> <td>\ref_rfc20130316</td> <td></td> </tr> -<tr> <td>2012-11-14</td> <td>\ref_rfc20121114</td> <td></td> </tr> -<tr> <td>2012-10-24</td> <td>\ref_rfc20121024</td> <td></td> </tr> -<tr> <td>2012-08-28</td> <td>\ref_rfc20120828</td> <td></td> </tr> -<tr> <td>2012-05-23</td> <td>\ref_rfc20120523</td> <td></td> </tr> -<tr> <td>2012-05-01</td> <td>\ref_rfc20120501</td> <td></td> </tr> -<tr> <td>2012-03-05</td> <td>\ref_rfc20120305</td> <td></td> </tr> -<tr> <td>2012-02-20</td> <td>\ref_rfc20120220</td> <td></td> </tr> -<tr> <td>2012-01-20</td> <td>\ref_rfc20120120</td> <td></td> </tr> -<tr> <td>2012-01-04</td> <td>\ref_rfc20120104</td> <td></td> </tr> -<tr> <td>2011-11-19</td> <td>\ref_rfc20111119</td> <td></td> </tr> -<tr> <td>2011-08-25</td> <td>\ref_rfc20110825</td> <td></td> </tr> -<tr> <td>2011-08-11</td> <td>\ref_rfc20110811</td> <td></td> </tr> -<tr> <td>2011-07-26</td> <td>\ref_rfc20110726</td> <td></td> </tr> -<tr> <td>2011-06-14</td> <td>\ref_rfc20110614</td> <td></td> </tr> -<tr> <td>2011-03-29</td> <td>\ref_rfc20110329</td> <td></td> </tr> -<tr> <td>2011-01-18</td> <td>\ref_rfc20110118</td> <td></td> </tr> -<tr> <td>2010-11-22</td> <td>\ref_rfc20101122</td> <td></td> </tr> -<tr> <td>2010-11-04</td> <td>\ref_rfc20101104</td> <td></td> </tr> -<tr> <td>2010-10-18</td> <td>\ref_rfc20101018</td> <td></td> </tr> -<tr> <td>2010-09-02</td> <td>\ref_rfc20100902</td> <td></td> </tr> -<tr> <td>2010-07-27</td> <td>\ref_rfc20100727</td> <td></td> </tr> -<tr> <td>2010-07-26</td> <td>\ref_rfc20100726</td> <td></td> </tr> -<tr> <td>2010-05-11</td> <td>\ref_rfc20100511</td> <td></td> </tr> -<tr> <td>2010-04-22</td> <td>\ref_rfc20100422</td> <td></td> </tr> -<tr> <td>2010-03-12</td> <td>\ref_rfc20100312</td> <td></td> </tr> -<tr> <td>2009-12-18</td> <td>\ref_rfc20091218</td> <td></td> </tr> -<tr> <td>2009-09-07</td> <td>\ref_rfc20090907</td> <td></td> </tr> -<tr> <td>2009-06-12</td> <td>\ref_rfc20090612</td> <td></td> </tr> -<tr> <td>2008-12-18</td> <td>\ref_rfc20081218</td> <td></td> </tr> -<tr> <td>2008-12-05</td> <td>\ref_rfc20081205</td> <td></td> </tr> -<tr> <td>2008-10-30</td> <td>\ref_rfc20081030</td> <td></td> </tr> -<tr> <td>2008-09-15</td> <td>\ref_rfc20080915</td> <td></td> </tr> -<tr> <td>2008-09-04</td> <td>\ref_rfc20080904</td> <td></td> </tr> -<tr> <td>2008-07-28</td> <td>\ref_rfc20080728</td> <td></td> </tr> -<tr> <td>2008-07-23</td> <td>\ref_rfc20080723</td> <td></td> </tr> -<tr> <td>2008-03-01</td> <td>\ref_rfc20080301</td> <td></td> </tr> -<tr> <td>2008-02-09</td> <td>\ref_rfc20080209</td> <td></td> </tr> -<tr> <td>2008-02-06</td> <td>\ref_rfc20080206</td> <td></td> </tr> -<tr> <td>2007-11-11</td> <td>\ref_rfc20071111</td> <td></td> </tr> -<tr> <td>2007-10-18</td> <td>\ref_rfc20071018</td> <td></td> </tr> -<tr> <td>2007-08-01</td> <td>\ref_rfc20070801</td> <td></td> </tr> -<tr> <td>2007-04-13</td> <td>\ref_rfc20070413</td> <td></td> </tr> -<tr> <td>2007-01-15</td> <td>\ref_rfc20070115</td> <td></td> </tr> -<tr> <td>2006-06-23</td> <td>\ref_rfc20060623</td> <td></td> </tr> -<tr> <td>2006-06-04</td> <td>\ref_rfc20060604</td> <td></td> </tr> -<tr> <td>2006-05-05</td> <td>\ref_rfc20060505</td> <td></td> </tr> -<tr> <td>2006-04-10</td> <td>\ref_rfc20060410</td> <td></td> </tr> -<tr> <td>2006-03-17</td> <td>\ref_rfc20060317</td> <td></td> </tr> -<tr> <td>2006-01-24</td> <td>\ref_rfc20060124</td> <td></td> </tr> -<tr> <td>2004-08-11</td> <td>\ref_rfc20040811</td> <td></td> </tr> +<tr><th>RFC ID</th><th>Title</th></tr> +<tr> <td>2022-08-19</td> <td>\ref_rfc20220819</td></tr> +<tr> <td>2021-05-28</td> <td>\ref_rfc20210528</td></tr> +<tr> <td>2021-02-19</td> <td>\ref_rfc20210219</td></tr> +<tr> <td>2020-02-13</td> <td>\ref_rfc20200213</td></tr> +<tr> <td>2020-02-10</td> <td>\ref_rfc20200210</td></tr> +<tr> <td>2019-09-23</td> <td>\ref_rfc20190923</td></tr> +<tr> <td>2019-07-15</td> <td>\ref_rfc20190715</td></tr> +<tr> <td>2019-04-10</td> <td>\ref_rfc20190410</td></tr> +<tr> <td>2018-12-31</td> <td>\ref_rfc20181231</td></tr> +<tr> <td>2018-12-20</td> <td>\ref_rfc20181220</td></tr> +<tr> <td>2018-08-30</td> <td>\ref_rfc20180830</td></tr> +<tr> <td>2018-08-29</td> <td>\ref_rfc20180829</td></tr> +<tr> <td>2018-08-15</td> <td>\ref_rfc20180815</td></tr> +<tr> <td>2018-07-12</td> <td>\ref_rfc20180712</td></tr> +<tr> <td>2018-06-20</td> <td>\ref_rfc20180620</td></tr> +<tr> <td>2018-06-10</td> <td>\ref_rfc20180610</td></tr> +<tr> <td>2018-03-21</td> <td>\ref_rfc20180321</td></tr> +<tr> <td>2018-01-25</td> <td>\ref_rfc20180125</td></tr> +<tr> <td>2017-07-07</td> <td>\ref_rfc20170707</td></tr> +<tr> <td>2016-01-05</td> <td>\ref_rfc20160105</td></tr> +<tr> <td>2015-09-15</td> <td>\ref_rfc20150915</td></tr> +<tr> <td>2015-07-09</td> <td>\ref_rfc20150709</td></tr> +<tr> <td>2015-06-15</td> <td>\ref_rfc20150615</td></tr> +<tr> <td>2015-04-29</td> <td>\ref_rfc20150429</td></tr> +<tr> <td>2015-04-24</td> <td>\ref_rfc20150424</td></tr> +<tr> <td>2015-04-23</td> <td>\ref_rfc20150423</td></tr> +<tr> <td>2015-03-01</td> <td>\ref_rfc20150301</td></tr> +<tr> <td>2015-02-12</td> <td>\ref_rfc20150212</td></tr> +<tr> <td>2015-02-05</td> <td>\ref_rfc20150205</td></tr> +<tr> <td>2015-02-02</td> <td>\ref_rfc20150202</td></tr> +<tr> <td>2014-12-10</td> <td>\ref_rfc20141210</td></tr> +<tr> <td>2014-12-01</td> <td>\ref_rfc20141201</td></tr> +<tr> <td>2014-09-16</td> <td>\ref_rfc20140916</td></tr> +<tr> <td>2014-08-27</td> <td>\ref_rfc20140827</td></tr> +<tr> <td>2014-07-29</td> <td>\ref_rfc20140729</td></tr> +<tr> <td>2014-07-22</td> <td>\ref_rfc20140722</td></tr> +<tr> <td>2014-07-17</td> <td>\ref_rfc20140717</td></tr> +<tr> <td>2014-07-07</td> <td>\ref_rfc20140707</td></tr> +<tr> <td>2014-05-24</td> <td>\ref_rfc20140524</td></tr> +<tr> <td>2014-03-18</td> <td>\ref_rfc20140318</td></tr> +<tr> <td>2014-03-13</td> <td>\ref_rfc20140313</td></tr> +<tr> <td>2014-02-24</td> <td>\ref_rfc20140224</td></tr> +<tr> <td>2013-12-11</td> <td>\ref_rfc20131211</td></tr> +<tr> <td>2013-09-30</td> <td>\ref_rfc20130930</td></tr> +<tr> <td>2013-09-19</td> <td>\ref_rfc20130919</td></tr> +<tr> <td>2013-06-30</td> <td>\ref_rfc20130630</td></tr> +<tr> <td>2013-03-16</td> <td>\ref_rfc20130316</td></tr> +<tr> <td>2012-11-14</td> <td>\ref_rfc20121114</td></tr> +<tr> <td>2012-10-24</td> <td>\ref_rfc20121024</td></tr> +<tr> <td>2012-08-28</td> <td>\ref_rfc20120828</td></tr> +<tr> <td>2012-05-23</td> <td>\ref_rfc20120523</td></tr> +<tr> <td>2012-05-01</td> <td>\ref_rfc20120501</td></tr> +<tr> <td>2012-03-05</td> <td>\ref_rfc20120305</td></tr> +<tr> <td>2012-02-20</td> <td>\ref_rfc20120220</td></tr> +<tr> <td>2012-01-20</td> <td>\ref_rfc20120120</td></tr> +<tr> <td>2012-01-04</td> <td>\ref_rfc20120104</td></tr> +<tr> <td>2011-11-19</td> <td>\ref_rfc20111119</td></tr> +<tr> <td>2011-08-25</td> <td>\ref_rfc20110825</td></tr> +<tr> <td>2011-08-11</td> <td>\ref_rfc20110811</td></tr> +<tr> <td>2011-07-26</td> <td>\ref_rfc20110726</td></tr> +<tr> <td>2011-06-14</td> <td>\ref_rfc20110614</td></tr> +<tr> <td>2011-03-29</td> <td>\ref_rfc20110329</td></tr> +<tr> <td>2011-01-18</td> <td>\ref_rfc20110118</td></tr> +<tr> <td>2010-11-22</td> <td>\ref_rfc20101122</td></tr> +<tr> <td>2010-11-04</td> <td>\ref_rfc20101104</td></tr> +<tr> <td>2010-10-18</td> <td>\ref_rfc20101018</td></tr> +<tr> <td>2010-09-02</td> <td>\ref_rfc20100902</td></tr> +<tr> <td>2010-07-27</td> <td>\ref_rfc20100727</td></tr> +<tr> <td>2010-07-26</td> <td>\ref_rfc20100726</td></tr> +<tr> <td>2010-05-11</td> <td>\ref_rfc20100511</td></tr> +<tr> <td>2010-04-22</td> <td>\ref_rfc20100422</td></tr> +<tr> <td>2010-03-12</td> <td>\ref_rfc20100312</td></tr> +<tr> <td>2009-12-18</td> <td>\ref_rfc20091218</td></tr> +<tr> <td>2009-09-07</td> <td>\ref_rfc20090907</td></tr> +<tr> <td>2009-06-12</td> <td>\ref_rfc20090612</td></tr> +<tr> <td>2008-12-18</td> <td>\ref_rfc20081218</td></tr> +<tr> <td>2008-12-05</td> <td>\ref_rfc20081205</td></tr> +<tr> <td>2008-10-30</td> <td>\ref_rfc20081030</td></tr> +<tr> <td>2008-09-15</td> <td>\ref_rfc20080915</td></tr> +<tr> <td>2008-09-04</td> <td>\ref_rfc20080904</td></tr> +<tr> <td>2008-07-28</td> <td>\ref_rfc20080728</td></tr> +<tr> <td>2008-07-23</td> <td>\ref_rfc20080723</td></tr> +<tr> <td>2008-03-01</td> <td>\ref_rfc20080301</td></tr> +<tr> <td>2008-02-09</td> <td>\ref_rfc20080209</td></tr> +<tr> <td>2008-02-06</td> <td>\ref_rfc20080206</td></tr> +<tr> <td>2007-11-11</td> <td>\ref_rfc20071111</td></tr> +<tr> <td>2007-10-18</td> <td>\ref_rfc20071018</td></tr> +<tr> <td>2007-08-01</td> <td>\ref_rfc20070801</td></tr> +<tr> <td>2007-04-13</td> <td>\ref_rfc20070413</td></tr> +<tr> <td>2007-01-15</td> <td>\ref_rfc20070115</td></tr> +<tr> <td>2006-06-23</td> <td>\ref_rfc20060623</td></tr> +<tr> <td>2006-06-04</td> <td>\ref_rfc20060604</td></tr> +<tr> <td>2006-05-05</td> <td>\ref_rfc20060505</td></tr> +<tr> <td>2006-04-10</td> <td>\ref_rfc20060410</td></tr> +<tr> <td>2006-03-17</td> <td>\ref_rfc20060317</td></tr> +<tr> <td>2006-01-24</td> <td>\ref_rfc20060124</td></tr> +<tr> <td>2004-08-11</td> <td>\ref_rfc20040811</td></tr> </table> */ diff --git a/doxygen/dox/ReferenceManual.dox b/doxygen/dox/ReferenceManual.dox index 7900925..e79de67 100644 --- a/doxygen/dox/ReferenceManual.dox +++ b/doxygen/dox/ReferenceManual.dox @@ -8,29 +8,140 @@ The functions provided by the HDF5 API are grouped into the following <tr valign="top"> <td> <table> -<tr valign="top"><td style="border: none;"> -\include{doc} core_menu.md +<caption>Core Reference Manual Modules</caption> +<tr><th>Module</th><th colspan="4">Language</th><th>Description</th></tr> +<tr> +<th>Attributes (H5A)</th><td>@ref H5A "C"</td><td>@ref H5::Attribute "C++"</td><td>@ref FH5A "Fortran"</td><td>@ref JH5A "Java"</td><td>HDF5 attribute is a small metadata object describing the nature and/or intended usage of a primary data object. +</td> +</tr> +<tr> +<th>Datasets (H5D)</th><td>@ref H5D "C"</td><td>@ref H5::DataSet "C++"</td><td>@ref FH5D "Fortran"</td><td>@ref JH5D "Java"</td><td>Manage HDF5 datasets, including the transfer of data between memory and disk and the description of dataset properties. +</td> +</tr> +<tr> +<th>Dataspaces (H5S)</th><td>@ref H5S "C"</td><td>@ref H5::DataSpace "C++"</td><td>@ref FH5S "Fortran"</td><td>@ref JH5S "Java"</td><td>HDF5 dataspaces describe the shape of datasets in memory or in HDF5 files. +</td> +</tr> +<tr> +<th>Datatypes (H5T)</th><td>@ref H5T "C"</td><td>@ref H5::DataType "C++"</td><td>@ref FH5T "Fortran"</td><td>@ref JH5T "Java"</td><td>HDF5 datatypes describe the element type of HDF5 datasets and attributes. +</td> +</tr> +<tr> +<th>Error Handling (H5E)</th><td>@ref H5E "C"</td><td>@ref H5::Exception "C++"</td><td>@ref FH5E "Fortran"</td><td>@ref JH5E "Java"</td><td>HDF5 library error reporting. +</td> +</tr> +<tr> +<th>Event Set (H5ES)</th><td>@ref H5ES "C"</td><td>"C++"</td><td>"Fortran"</td><td>"Java"</td><td>HDF5 event set life cycle used with HDF5 VOL connectors that enable the asynchronous feature in HDF5. +</td> +</tr> +<tr> +<th>Files (H5F)</th><td>@ref H5F "C"</td><td>@ref H5::H5File "C++"</td><td>@ref FH5F "Fortran"</td><td>@ref JH5F "Java"</td><td>Manage HDF5 files. +</td> +</tr> +<tr> +<th>Filters (H5Z)</th><td>@ref H5Z "C"</td><td>"C++"</td><td>@ref FH5Z "Fortran"</td><td>@ref JH5Z "Java"</td><td>Manage HDF5 user-defined filters +</td> +</tr> +<tr> +<th>Groups (H5G)</th><td>@ref H5G "C"</td><td>@ref H5::Group "C++"</td><td>@ref FH5G "Fortran"</td><td>@ref JH5G "Java"</td><td>Manage HDF5 groups. +</td> +</tr> +<tr> +<th>Identifiers (H5I)</th><td>@ref H5I "C"</td><td>@ref H5::IdComponent "C++"</td><td>@ref FH5I "Fortran"</td><td>@ref JH5I "Java"</td><td>Manage identifiers defined by the HDF5 library. +</td> +</tr> +<tr> +<th>Library General (%H5)</th><td>@ref H5 "C"</td><td>@ref H5::H5Library "C++"</td><td>@ref FH5 "Fortran"</td><td>@ref JH5 "Java"</td><td>Manage the life cycle of HDF5 library instances. +</td> +</tr> +<tr> +<th>Links (H5L)</th><td>@ref H5L "C"</td><td>"C++"</td><td>@ref FH5L "Fortran"</td><td>@ref JH5L "Java"</td><td>Manage HDF5 links and link types. +</td> +</tr> +<tr> +<th>Objects (H5O)</th><td>@ref H5O "C"</td><td>"C++"</td><td>@ref FH5O "Fortran"</td><td>@ref JH5O "Java"</td><td>Manage HDF5 objects (groups, datasets, datatype objects). +</td> +</tr> +<tr> +<th>Property Lists (H5P)</th><td>@ref H5P "C"</td><td>@ref H5::PropList "C++"</td><td>@ref FH5P "Fortran"</td><td>@ref JH5P "Java"</td><td>HDF5 property lists are the main vehicle to configure the behavior of HDF5 API functions. +</td> +</tr> +<tr> +<th>Dynamically-loaded Plugins (H5PL)</th><td>@ref H5PL "C"</td><td>"C++"</td><td>"Fortran"</td><td>@ref JH5PL "Java"</td><td>Manage the loading behavior of HDF5 plugins. +</td> +</tr> +<tr> +<th>References (H5R)</th><td>@ref H5R "C"</td><td>"C++"</td><td>@ref FH5R "Fortran"</td><td>@ref JH5R "Java"</td><td>Manage HDF5 references (HDF5 objects, attributes, and selections on datasets a.k.a. dataset regions). +</td> +</tr> +<tr> +<th>VOL Connector (H5VL)</th><td>@ref H5VL "C"</td><td>"C++"</td><td>@ref FH5VL "Fortran"</td><td>@ref JH5VL "Java"</td><td>Manage HDF5 VOL connector plugins. +</td> +</tr> +</table> +<table> +<caption>High-level Reference Manual Modules</caption> +<tr><th>Module</th><th colspan="4"></th>Language<th>Description</th></tr> +<tr> +<th>HDF5 Lite APIs (H5LT,H5LD)</th><td>@ref H5LT "C"</td><td>"C++"</td><td>@ref FH5LT "Fortran"</td><td>"Java"</td><td>Functions to simplify creating and manipulating datasets, attributes and other features. +</td> +</tr> +<tr> +<th>HDF5 Images API (H5IM)</th><td>@ref H5IM "C"</td><td>"C++"</td><td>@ref FH5IM "Fortran"</td><td>"Java"</td><td>Creating and manipulating HDF5 datasets intended to be interpreted as images. +</td> +</tr> +<tr> +<th>HDF5 Table APIs (H5TB)</th><td>@ref H5TB "C"</td><td>"C++"</td><td>@ref FH5TB "Fortran"</td><td>"Java"</td><td>Creating and manipulating HDF5 datasets intended to be interpreted as tables. +</td> +</tr> +<tr> +<th>HDF5 Packet Table APIs (H5PT)</th><td>@ref H5PT "C"</td><td>"C++"</td><td>"Fortran"</td><td>"Java"</td><td>Creating and manipulating HDF5 datasets to support append- and read-only operations on table data. +</td> +</tr> +<tr> +<th>HDF5 Dimension Scales APIs (H5DS)</th><td>@ref H5DS "C"</td><td>"C++"</td><td>@ref FH5DS "Fortran"</td><td>"Java"</td><td>Creating and manipulating HDF5 datasets that are associated with the dimension of another HDF5 dataset. </td> </tr> -<tr valign="top"><td style="border: none;"> -<!-- High-level library --> -\include{doc} high_level_menu.md +<tr> +<th>HDF5 Optimizations APIs (H5DO)</th><td>@ref H5DO "C"</td><td>"C++"</td><td>"Fortran"</td><td>"Java"</td><td>Bypassing default HDF5 behavior in order to optimize for specific use cases. +</td> +</tr> +<tr> +<th>Extensions (H5LR, H5LT)</th><td>@ref H5LR "C"</td><td>"C++"</td><td>"Fortran"</td><td>"Java"</td><td> +</td> +</tr> +</table> +</td> +</tr> +<tr><td> +<table> +<caption>Additional Java Reference Manual Modules</caption> +<tr> +<td>@ref HDF5CONST</td><td>This class contains C constants and enumerated types of HDF5 library. </td> </tr> -<tr valign="top"><td style="border: none;"> -<!-- Fortran library --> -\include{doc} fortran_menu.md +<tr> +<td>@ref HDFNATIVE</td><td>This class encapsulates native methods to deal with arrays of numbers, converting from numbers to bytes and bytes to numbers. </td> </tr> -<tr valign="top"><td style="border: none;"> -<!-- Java library --> -\include{doc} java_menu.md +<tr> +<td>@ref HDFARRAY</td><td>This is a class for handling multidimensional arrays for HDF. </td> </tr> <tr> -<td><a href="./deprecated.html">Deprecated functions</a></td> -<td>Functions with \ref ASYNC</td> -<td>\ref api-compat-macros</td> +<td>@ref ERRORS</td><td>The class HDF5Exception returns errors from the Java HDF5 Interface. +</td> +</tr> +</table> +</td> +</tr> +<tr> +<td> +\ref predefined_datatypes_tables<br /> +<a href="./deprecated.html">Deprecated functions</a><br /> +Functions with \ref ASYNC<br /> +\ref api-compat-macros +</td> </tr> </table> |