From dcd332d2310d3f402a01ebfc187dc36101662d71 Mon Sep 17 00:00:00 2001 From: Allen Byrne <50328838+byrnHDF@users.noreply.github.com> Date: Mon, 26 Sep 2022 22:49:29 -0500 Subject: Restructure ref manual presentation (#2123) --- configure.ac | 6 +- doxygen/Doxyfile.in | 42 +- doxygen/dox/PredefinedDatatypeTables.dox | 22 + doxygen/dox/RFC.dox | 196 ++++---- doxygen/dox/ReferenceManual.dox | 139 +++++- doxygen/examples/core_menu.md | 69 --- doxygen/examples/fortran_menu.md | 73 --- doxygen/examples/high_level_menu.md | 30 -- doxygen/examples/java_menu.md | 84 ---- doxygen/examples/menus/core_menu.md | 69 +++ doxygen/examples/menus/fortran_menu.md | 73 +++ doxygen/examples/menus/high_level_menu.md | 30 ++ doxygen/examples/menus/java_menu.md | 84 ++++ doxygen/examples/tables/predefinedDatatypes.dox | 629 ++++++++++++++++++++++++ doxygen/hdf5doxy_layout.xml | 1 - src/H5Tmodule.h | 34 +- 16 files changed, 1158 insertions(+), 423 deletions(-) create mode 100644 doxygen/dox/PredefinedDatatypeTables.dox delete mode 100644 doxygen/examples/core_menu.md delete mode 100644 doxygen/examples/fortran_menu.md delete mode 100644 doxygen/examples/high_level_menu.md delete mode 100644 doxygen/examples/java_menu.md create mode 100644 doxygen/examples/menus/core_menu.md create mode 100644 doxygen/examples/menus/fortran_menu.md create mode 100644 doxygen/examples/menus/high_level_menu.md create mode 100644 doxygen/examples/menus/java_menu.md create mode 100644 doxygen/examples/tables/predefinedDatatypes.dox diff --git a/configure.ac b/configure.ac index ab9897b..d66d473 100644 --- a/configure.ac +++ b/configure.ac @@ -1239,9 +1239,11 @@ if test "X$HDF5_DOXYGEN" = "Xyes"; then DOXYGEN_PACKAGE=${PACKAGE_NAME} DOXYGEN_VERSION_STRING=${PACKAGE_VERSION} DOXYGEN_DIR='$(SRCDIR)/doxygen' + DOXYGEN_INCLUDE_ALIASES_PATH='$(SRCDIR)/doxygen' DOXYGEN_INCLUDE_ALIASES='$(SRCDIR)/doxygen/aliases' + DOXYGEN_VERBATIM_VARS='DOXYGEN_INCLUDE_ALIASES' DOXYGEN_PROJECT_LOGO='$(SRCDIR)/doxygen/img/HDFG-logo.png' - DOXYGEN_PROJECT_BRIEF='' + DOXYGEN_PROJECT_BRIEF='API Reference' DOXYGEN_INPUT_DIRECTORY='$(SRCDIR) $(SRCDIR)/doxygen/dox' DOXYGEN_OPTIMIZE_OUTPUT_FOR_C=YES DOXYGEN_MACRO_EXPANSION=YES @@ -1258,7 +1260,7 @@ if test "X$HDF5_DOXYGEN" = "Xyes"; then DOXYGEN_SEARCHENGINE_URL= DOXYGEN_STRIP_FROM_PATH='$(SRCDIR)' DOXYGEN_STRIP_FROM_INC_PATH='$(SRCDIR)' - DOXYGEN_PREDEFINED='H5_HAVE_DIRECT H5_HAVE_LIBHDFS H5_HAVE_MAP_API H5_HAVE_PARALLEL H5_HAVE_ROS3_VFD H5_DOXYGEN_FORTRAN' + DOXYGEN_PREDEFINED='H5_HAVE_DIRECT H5_HAVE_LIBHDFS H5_HAVE_MAP_API H5_HAVE_PARALLEL H5_HAVE_ROS3_VFD H5_DOXYGEN_FORTRAN H5_HAVE_SUBFILING_VFD H5_HAVE_IOC_VFD' DX_INIT_DOXYGEN([HDF5], [./doxygen/Doxyfile], [hdf5lib_docs]) fi diff --git a/doxygen/Doxyfile.in b/doxygen/Doxyfile.in index 08f5545..393507c 100644 --- a/doxygen/Doxyfile.in +++ b/doxygen/Doxyfile.in @@ -853,34 +853,20 @@ INPUT_ENCODING = UTF-8 # C comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd, # *.vhdl, *.ucf, *.qsf and *.ice. -FILE_PATTERNS = H5*public.h \ - H5*module.h \ - H5*develop.h \ - H5FDcore.h \ - H5FDdirect.h \ - H5FDfamily.h \ - H5FDhdfs.h \ - H5FDioc.h \ - H5FDlog.h \ - H5FDmirror.h \ - H5FDmpi.h \ - H5FDmpio.h \ - H5FDmulti.h \ - H5FDros3.h \ - H5FDsec2.h \ - H5FDsplitter.h \ - H5FDstdio.h \ - H5FDsubfiling.h \ - H5FDwindows.h \ - H5VLconnector.h \ - H5VLconnector_passthru.h \ - H5VLnative.h \ - H5Zdevelop.h \ - H5version.h \ - H5*.java \ - HDF*.java \ - *.F90 \ - *.dox +FILE_PATTERNS = H5*public.h H5*module.h H5*develop.h H5FD*.h \ + H5VLconnector.h H5VLconnector_passthru.h H5VLnative.h \ + H5Zdevelop.h \ + H5version.h \ + H5*.java \ + HDF*.java \ + *.F90 \ + *.dox \ + H5Cpp.h H5AbstractDs.h H5AtomType.h H5Attribute.h H5CommonFG.h H5CompType.h \ + H5DataSet.h H5DataSpace.h H5DataType.h H5OcreatProp.h H5DaccProp.h H5DcreatProp.h \ + H5DxferProp.h H5EnumType.h H5Exception.h H5FaccProp.h H5FcreatProp.h H5File.h \ + H5FloatType.h H5Group.h H5IdComponent.h H5Include.h H5IntType.h H5LcreatProp.h \ + H5LaccProp.h H5Library.h H5Location.h H5Object.h H5PredType.h H5PropList.h H5StrType.h \ + H5ArrayType.h H5VarLenType.h # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. 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 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
RFC IDTitleComments
2022-08-19 \ref_rfc20220819
2021-05-28 \ref_rfc20210528
2021-02-19 \ref_rfc20210219
2020-02-13 \ref_rfc20200213
2020-02-10 \ref_rfc20200210
2019-09-23 \ref_rfc20190923
2019-07-15 \ref_rfc20190715
2019-04-10 \ref_rfc20190410
2018-12-31 \ref_rfc20181231
2018-12-20 \ref_rfc20181220
2018-08-30 \ref_rfc20180830
2018-08-29 \ref_rfc20180829
2018-08-15 \ref_rfc20180815
2018-07-12 \ref_rfc20180712
2018-06-20 \ref_rfc20180620
2018-06-10 \ref_rfc20180610
2018-03-21 \ref_rfc20180321
2018-01-25 \ref_rfc20180125
2017-07-07 \ref_rfc20170707
2016-01-05 \ref_rfc20160105
2015-09-15 \ref_rfc20150915
2015-07-09 \ref_rfc20150709
2015-06-15 \ref_rfc20150615
2015-04-29 \ref_rfc20150429
2015-04-24 \ref_rfc20150424
2015-04-23 \ref_rfc20150423
2015-03-01 \ref_rfc20150301
2015-02-12 \ref_rfc20150212
2015-02-05 \ref_rfc20150205
2015-02-02 \ref_rfc20150202
2014-12-10 \ref_rfc20141210
2014-12-01 \ref_rfc20141201
2014-09-16 \ref_rfc20140916
2014-08-27 \ref_rfc20140827
2014-07-29 \ref_rfc20140729
2014-07-22 \ref_rfc20140722
2014-07-17 \ref_rfc20140717
2014-07-07 \ref_rfc20140707
2014-05-24 \ref_rfc20140524
2014-03-18 \ref_rfc20140318
2014-03-13 \ref_rfc20140313
2014-02-24 \ref_rfc20140224
2013-12-11 \ref_rfc20131211
2013-09-30 \ref_rfc20130930
2013-09-19 \ref_rfc20130919
2013-06-30 \ref_rfc20130630
2013-03-16 \ref_rfc20130316
2012-11-14 \ref_rfc20121114
2012-10-24 \ref_rfc20121024
2012-08-28 \ref_rfc20120828
2012-05-23 \ref_rfc20120523
2012-05-01 \ref_rfc20120501
2012-03-05 \ref_rfc20120305
2012-02-20 \ref_rfc20120220
2012-01-20 \ref_rfc20120120
2012-01-04 \ref_rfc20120104
2011-11-19 \ref_rfc20111119
2011-08-25 \ref_rfc20110825
2011-08-11 \ref_rfc20110811
2011-07-26 \ref_rfc20110726
2011-06-14 \ref_rfc20110614
2011-03-29 \ref_rfc20110329
2011-01-18 \ref_rfc20110118
2010-11-22 \ref_rfc20101122
2010-11-04 \ref_rfc20101104
2010-10-18 \ref_rfc20101018
2010-09-02 \ref_rfc20100902
2010-07-27 \ref_rfc20100727
2010-07-26 \ref_rfc20100726
2010-05-11 \ref_rfc20100511
2010-04-22 \ref_rfc20100422
2010-03-12 \ref_rfc20100312
2009-12-18 \ref_rfc20091218
2009-09-07 \ref_rfc20090907
2009-06-12 \ref_rfc20090612
2008-12-18 \ref_rfc20081218
2008-12-05 \ref_rfc20081205
2008-10-30 \ref_rfc20081030
2008-09-15 \ref_rfc20080915
2008-09-04 \ref_rfc20080904
2008-07-28 \ref_rfc20080728
2008-07-23 \ref_rfc20080723
2008-03-01 \ref_rfc20080301
2008-02-09 \ref_rfc20080209
2008-02-06 \ref_rfc20080206
2007-11-11 \ref_rfc20071111
2007-10-18 \ref_rfc20071018
2007-08-01 \ref_rfc20070801
2007-04-13 \ref_rfc20070413
2007-01-15 \ref_rfc20070115
2006-06-23 \ref_rfc20060623
2006-06-04 \ref_rfc20060604
2006-05-05 \ref_rfc20060505
2006-04-10 \ref_rfc20060410
2006-03-17 \ref_rfc20060317
2006-01-24 \ref_rfc20060124
2004-08-11 \ref_rfc20040811
RFC IDTitle
2022-08-19 \ref_rfc20220819
2021-05-28 \ref_rfc20210528
2021-02-19 \ref_rfc20210219
2020-02-13 \ref_rfc20200213
2020-02-10 \ref_rfc20200210
2019-09-23 \ref_rfc20190923
2019-07-15 \ref_rfc20190715
2019-04-10 \ref_rfc20190410
2018-12-31 \ref_rfc20181231
2018-12-20 \ref_rfc20181220
2018-08-30 \ref_rfc20180830
2018-08-29 \ref_rfc20180829
2018-08-15 \ref_rfc20180815
2018-07-12 \ref_rfc20180712
2018-06-20 \ref_rfc20180620
2018-06-10 \ref_rfc20180610
2018-03-21 \ref_rfc20180321
2018-01-25 \ref_rfc20180125
2017-07-07 \ref_rfc20170707
2016-01-05 \ref_rfc20160105
2015-09-15 \ref_rfc20150915
2015-07-09 \ref_rfc20150709
2015-06-15 \ref_rfc20150615
2015-04-29 \ref_rfc20150429
2015-04-24 \ref_rfc20150424
2015-04-23 \ref_rfc20150423
2015-03-01 \ref_rfc20150301
2015-02-12 \ref_rfc20150212
2015-02-05 \ref_rfc20150205
2015-02-02 \ref_rfc20150202
2014-12-10 \ref_rfc20141210
2014-12-01 \ref_rfc20141201
2014-09-16 \ref_rfc20140916
2014-08-27 \ref_rfc20140827
2014-07-29 \ref_rfc20140729
2014-07-22 \ref_rfc20140722
2014-07-17 \ref_rfc20140717
2014-07-07 \ref_rfc20140707
2014-05-24 \ref_rfc20140524
2014-03-18 \ref_rfc20140318
2014-03-13 \ref_rfc20140313
2014-02-24 \ref_rfc20140224
2013-12-11 \ref_rfc20131211
2013-09-30 \ref_rfc20130930
2013-09-19 \ref_rfc20130919
2013-06-30 \ref_rfc20130630
2013-03-16 \ref_rfc20130316
2012-11-14 \ref_rfc20121114
2012-10-24 \ref_rfc20121024
2012-08-28 \ref_rfc20120828
2012-05-23 \ref_rfc20120523
2012-05-01 \ref_rfc20120501
2012-03-05 \ref_rfc20120305
2012-02-20 \ref_rfc20120220
2012-01-20 \ref_rfc20120120
2012-01-04 \ref_rfc20120104
2011-11-19 \ref_rfc20111119
2011-08-25 \ref_rfc20110825
2011-08-11 \ref_rfc20110811
2011-07-26 \ref_rfc20110726
2011-06-14 \ref_rfc20110614
2011-03-29 \ref_rfc20110329
2011-01-18 \ref_rfc20110118
2010-11-22 \ref_rfc20101122
2010-11-04 \ref_rfc20101104
2010-10-18 \ref_rfc20101018
2010-09-02 \ref_rfc20100902
2010-07-27 \ref_rfc20100727
2010-07-26 \ref_rfc20100726
2010-05-11 \ref_rfc20100511
2010-04-22 \ref_rfc20100422
2010-03-12 \ref_rfc20100312
2009-12-18 \ref_rfc20091218
2009-09-07 \ref_rfc20090907
2009-06-12 \ref_rfc20090612
2008-12-18 \ref_rfc20081218
2008-12-05 \ref_rfc20081205
2008-10-30 \ref_rfc20081030
2008-09-15 \ref_rfc20080915
2008-09-04 \ref_rfc20080904
2008-07-28 \ref_rfc20080728
2008-07-23 \ref_rfc20080723
2008-03-01 \ref_rfc20080301
2008-02-09 \ref_rfc20080209
2008-02-06 \ref_rfc20080206
2007-11-11 \ref_rfc20071111
2007-10-18 \ref_rfc20071018
2007-08-01 \ref_rfc20070801
2007-04-13 \ref_rfc20070413
2007-01-15 \ref_rfc20070115
2006-06-23 \ref_rfc20060623
2006-06-04 \ref_rfc20060604
2006-05-05 \ref_rfc20060505
2006-04-10 \ref_rfc20060410
2006-03-17 \ref_rfc20060317
2006-01-24 \ref_rfc20060124
2004-08-11 \ref_rfc20040811
*/ 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 - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
-\include{doc} core_menu.md +
Core Reference Manual Modules
ModuleLanguageDescription
Attributes (H5A)@ref H5A "C"@ref H5::Attribute "C++"@ref FH5A "Fortran"@ref JH5A "Java"HDF5 attribute is a small metadata object describing the nature and/or intended usage of a primary data object. +
Datasets (H5D)@ref H5D "C"@ref H5::DataSet "C++"@ref FH5D "Fortran"@ref JH5D "Java"Manage HDF5 datasets, including the transfer of data between memory and disk and the description of dataset properties. +
Dataspaces (H5S)@ref H5S "C"@ref H5::DataSpace "C++"@ref FH5S "Fortran"@ref JH5S "Java"HDF5 dataspaces describe the shape of datasets in memory or in HDF5 files. +
Datatypes (H5T)@ref H5T "C"@ref H5::DataType "C++"@ref FH5T "Fortran"@ref JH5T "Java"HDF5 datatypes describe the element type of HDF5 datasets and attributes. +
Error Handling (H5E)@ref H5E "C"@ref H5::Exception "C++"@ref FH5E "Fortran"@ref JH5E "Java"HDF5 library error reporting. +
Event Set (H5ES)@ref H5ES "C""C++""Fortran""Java"HDF5 event set life cycle used with HDF5 VOL connectors that enable the asynchronous feature in HDF5. +
Files (H5F)@ref H5F "C"@ref H5::H5File "C++"@ref FH5F "Fortran"@ref JH5F "Java"Manage HDF5 files. +
Filters (H5Z)@ref H5Z "C""C++"@ref FH5Z "Fortran"@ref JH5Z "Java"Manage HDF5 user-defined filters +
Groups (H5G)@ref H5G "C"@ref H5::Group "C++"@ref FH5G "Fortran"@ref JH5G "Java"Manage HDF5 groups. +
Identifiers (H5I)@ref H5I "C"@ref H5::IdComponent "C++"@ref FH5I "Fortran"@ref JH5I "Java"Manage identifiers defined by the HDF5 library. +
Library General (%H5)@ref H5 "C"@ref H5::H5Library "C++"@ref FH5 "Fortran"@ref JH5 "Java"Manage the life cycle of HDF5 library instances. +
Links (H5L)@ref H5L "C""C++"@ref FH5L "Fortran"@ref JH5L "Java"Manage HDF5 links and link types. +
Objects (H5O)@ref H5O "C""C++"@ref FH5O "Fortran"@ref JH5O "Java"Manage HDF5 objects (groups, datasets, datatype objects). +
Property Lists (H5P)@ref H5P "C"@ref H5::PropList "C++"@ref FH5P "Fortran"@ref JH5P "Java"HDF5 property lists are the main vehicle to configure the behavior of HDF5 API functions. +
Dynamically-loaded Plugins (H5PL)@ref H5PL "C""C++""Fortran"@ref JH5PL "Java"Manage the loading behavior of HDF5 plugins. +
References (H5R)@ref H5R "C""C++"@ref FH5R "Fortran"@ref JH5R "Java"Manage HDF5 references (HDF5 objects, attributes, and selections on datasets a.k.a. dataset regions). +
VOL Connector (H5VL)@ref H5VL "C""C++"@ref FH5VL "Fortran"@ref JH5VL "Java"Manage HDF5 VOL connector plugins. +
+ + +Language + + + + + + + + + + + + + + - + + + + + +
High-level Reference Manual Modules
ModuleDescription
HDF5 Lite APIs (H5LT,H5LD)@ref H5LT "C""C++"@ref FH5LT "Fortran""Java"Functions to simplify creating and manipulating datasets, attributes and other features. +
HDF5 Images API (H5IM)@ref H5IM "C""C++"@ref FH5IM "Fortran""Java"Creating and manipulating HDF5 datasets intended to be interpreted as images. +
HDF5 Table APIs (H5TB)@ref H5TB "C""C++"@ref FH5TB "Fortran""Java"Creating and manipulating HDF5 datasets intended to be interpreted as tables. +
HDF5 Packet Table APIs (H5PT)@ref H5PT "C""C++""Fortran""Java"Creating and manipulating HDF5 datasets to support append- and read-only operations on table data. +
HDF5 Dimension Scales APIs (H5DS)@ref H5DS "C""C++"@ref FH5DS "Fortran""Java"Creating and manipulating HDF5 datasets that are associated with the dimension of another HDF5 dataset.
- -\include{doc} high_level_menu.md +
HDF5 Optimizations APIs (H5DO)@ref H5DO "C""C++""Fortran""Java"Bypassing default HDF5 behavior in order to optimize for specific use cases. +
Extensions (H5LR, H5LT)@ref H5LR "C""C++""Fortran""Java" +
+ + + + + + + - + - + - - - + + +
Additional Java Reference Manual Modules
@ref HDF5CONSTThis class contains C constants and enumerated types of HDF5 library.
- -\include{doc} fortran_menu.md +
@ref HDFNATIVEThis class encapsulates native methods to deal with arrays of numbers, converting from numbers to bytes and bytes to numbers.
- -\include{doc} java_menu.md +
@ref HDFARRAYThis is a class for handling multidimensional arrays for HDF.
Deprecated functionsFunctions with \ref ASYNC\ref api-compat-macros@ref ERRORSThe class HDF5Exception returns errors from the Java HDF5 Interface. +
+ + + + +\ref predefined_datatypes_tables
+Deprecated functions
+Functions with \ref ASYNC
+\ref api-compat-macros + diff --git a/doxygen/examples/core_menu.md b/doxygen/examples/core_menu.md deleted file mode 100644 index 3fd7d11..0000000 --- a/doxygen/examples/core_menu.md +++ /dev/null @@ -1,69 +0,0 @@ -Core Library - -- @ref H5A "Attributes (H5A)" -
-HDF5 attribute is a small metadata object describing the nature and/or intended usage of a primary data object. - -- @ref H5D "Datasets (H5D)" -
-Manage HDF5 datasets, including the transfer of data between memory and disk and the description of dataset properties. - -- @ref H5S "Dataspaces (H5S)" -
-HDF5 dataspaces describe the shape of datasets in memory or in HDF5 files. - -- @ref H5T "Datatypes (H5T)" -
-HDF5 datatypes describe the element type of HDF5 datasets and attributes. - -- @ref H5E "Error Handling (H5E)" -
-HDF5 library error reporting. - -- @ref H5ES "Event Set (H5ES)" -
-HDF5 event set life cycle used with HDF5 VOL connectors that enable the asynchronous feature in HDF5. - -- @ref H5F "Files (H5F)" -
-Manage HDF5 files. - -- @ref H5Z "Filters (H5Z)" -
-Manage HDF5 user-defined filters - -- @ref H5G "Groups (H5G)" -
-Manage HDF5 groups. - -- @ref H5I "Identifiers (H5I)" -
-Manage identifiers defined by the HDF5 library. - -- @ref H5 "Library General (H5)" -
-Manage the life cycle of HDF5 library instances. - -- @ref H5L "Links (H5L)" -
-Manage HDF5 links and link types. - -- @ref H5O "Objects (H5O)" -
-Manage HDF5 objects (groups, datasets, datatype objects). - -- @ref H5P "Property Lists (H5P)" -
-HDF5 property lists are the main vehicle to configure the behavior of HDF5 API functions. - -- @ref H5PL "Dynamically-loaded Plugins (H5PL)" -
-Manage the loading behavior of HDF5 plugins. - -- @ref H5R "References (H5R)" -
-Manage HDF5 references (HDF5 objects, attributes, and selections on datasets a.k.a. dataset regions). - -- @ref H5VL "VOL Connector (H5VL)" -
-Manage HDF5 VOL connector plugins. diff --git a/doxygen/examples/fortran_menu.md b/doxygen/examples/fortran_menu.md deleted file mode 100644 index 8ef4ead..0000000 --- a/doxygen/examples/fortran_menu.md +++ /dev/null @@ -1,73 +0,0 @@ -Fortran Library - -- @ref FH5A "Attributes (H5A)" -
-HDF5 attribute is a small metadata object describing the nature and/or intended usage of a primary data object. - -- @ref FH5D "Datasets (H5D)" -
-Manage HDF5 datasets, including the transfer of data between memory and disk and the description of dataset properties. - -- @ref FH5S "Dataspaces (H5S)" -
-HDF5 dataspaces describe the shape of datasets in memory or in HDF5 files. - -- @ref FH5T "Datatypes (H5T)" -
-HDF5 datatypes describe the element type of HDF5 datasets and attributes. - -- @ref FH5E "Error Handling (H5E)" -
-HDF5 library error reporting. - -- @ref FH5F "Files (H5F)" -
-Manage HDF5 files. - -- @ref FH5Z "Filters (H5Z)" -
-Manage HDF5 user-defined filters - -- @ref FH5G "Groups (H5G)" -
-Manage HDF5 groups. - -- @ref FH5I "Identifiers (H5I)" -
-Manage identifiers defined by the HDF5 library. - -- @ref FH5 "Library General (H5)" -
-Manage the life cycle of HDF5 library instances. - -- @ref FH5L "Links (H5L)" -
-Manage HDF5 links and link types. - -- @ref FH5O "Objects (H5O)" -
-Manage HDF5 objects (groups, datasets, datatype objects). - -- @ref FH5P "Property Lists (H5P)" -
-HDF5 property lists are the main vehicle to configure the behavior of HDF5 API functions. - -- @ref FH5R "References (H5R)" -
-Manage HDF5 references (HDF5 objects, attributes, and selections on datasets a.k.a. dataset regions). - -- @ref FH5LT "High Level Lite (H5LT)" -
-Functions to simplify creating and manipulating datasets, attributes and other features - -- @ref FH5IM "High Level Image (H5IM)" -
-Creating and manipulating HDF5 datasets intended to be interpreted as images - -- @ref FH5TB "High Level Table (H5TB)" -
-Creating and manipulating HDF5 datasets intended to be interpreted as tables - -- @ref FH5DS "High Level Dimension Scale (H5DS)" -
-Creating and manipulating HDF5 datasets that are associated with the dimension of another HDF5 dataset diff --git a/doxygen/examples/high_level_menu.md b/doxygen/examples/high_level_menu.md deleted file mode 100644 index d209bf4..0000000 --- a/doxygen/examples/high_level_menu.md +++ /dev/null @@ -1,30 +0,0 @@ -High-level library -
-The high-level HDF5 library includes several sets of convenience and standard-use APIs to -facilitate common HDF5 operations. - -- @ref H5LT -
-Functions to simplify creating and manipulating datasets, attributes and other features - -- @ref H5IM -
-Creating and manipulating HDF5 datasets intended to be interpreted as images - -- @ref H5TB -
-Creating and manipulating HDF5 datasets intended to be interpreted as tables - -- @ref H5PT -
-Creating and manipulating HDF5 datasets to support append- and read-only operations on table data - -- @ref H5DS -
-Creating and manipulating HDF5 datasets that are associated with the dimension of another HDF5 dataset - -- @ref H5DO -
-Bypassing default HDF5 behavior in order to optimize for specific use cases - -- @ref H5LR "Extensions (H5LR, H5LT)" diff --git a/doxygen/examples/java_menu.md b/doxygen/examples/java_menu.md deleted file mode 100644 index 1236838..0000000 --- a/doxygen/examples/java_menu.md +++ /dev/null @@ -1,84 +0,0 @@ -Java Library - @ref HDF5LIB - -- @ref JH5 -
-This package is the Java interface for the HDF5 library. - -- @ref JH5A -
-This package is the Java interface for the HDF5 library attribute APIs. - -- @ref JH5D -
-This package is the Java interface for the HDF5 library dataset APIs. - -- @ref JH5S -
-This package is the Java interface for the HDF5 library dataspace APIs. - -- @ref JH5T -
-This package is the Java interface for the HDF5 library datatype APIs. - -- @ref JH5E -
-This package is the Java interface for the HDF5 library error APIs. - -- @ref JH5F -
-This package is the Java interface for the HDF5 library file APIs. - -- @ref JH5Z -
-This package is the Java interface for the HDF5 library filter APIs. - -- @ref JH5G -
-This package is the Java interface for the HDF5 library group APIs. - -- @ref JH5I -
-This package is the Java interface for the HDF5 library identifier APIs. - -- @ref JH5L -
-This package is the Java interface for the HDF5 library links APIs. - -- @ref JH5O -
-This package is the Java interface for the HDF5 library object APIs. - -- @ref JH5P -
-This package is the Java interface for the HDF5 library property list APIs. - -- @ref JH5PL -
-This package is the Java interface for the HDF5 library plugin APIs. - -- @ref JH5R -
-This package is the Java interface for the HDF5 library reference APIs. - -- @ref JH5VL -
-This package is the Java interface for the HDF5 library VOL connector APIs. - -- @ref HDF5CONST -
-This class contains C constants and enumerated types of HDF5 library. - -- @ref HDFNATIVE -
-This class encapsulates native methods to deal with arrays of numbers, - * converting from numbers to bytes and bytes to numbers. - -- @ref HDFARRAY -
-This is a class for handling multidimensional arrays for HDF. - -- @ref ERRORS -
-The class HDF5Exception returns errors from the Java HDF5 Interface. - \ No newline at end of file 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 @@ +Core Library + +- @ref H5A "Attributes (H5A)" +
+HDF5 attribute is a small metadata object describing the nature and/or intended usage of a primary data object. + +- @ref H5D "Datasets (H5D)" +
+Manage HDF5 datasets, including the transfer of data between memory and disk and the description of dataset properties. + +- @ref H5S "Dataspaces (H5S)" +
+HDF5 dataspaces describe the shape of datasets in memory or in HDF5 files. + +- @ref H5T "Datatypes (H5T)" +
+HDF5 datatypes describe the element type of HDF5 datasets and attributes. + +- @ref H5E "Error Handling (H5E)" +
+HDF5 library error reporting. + +- @ref H5ES "Event Set (H5ES)" +
+HDF5 event set life cycle used with HDF5 VOL connectors that enable the asynchronous feature in HDF5. + +- @ref H5F "Files (H5F)" +
+Manage HDF5 files. + +- @ref H5Z "Filters (H5Z)" +
+Manage HDF5 user-defined filters + +- @ref H5G "Groups (H5G)" +
+Manage HDF5 groups. + +- @ref H5I "Identifiers (H5I)" +
+Manage identifiers defined by the HDF5 library. + +- @ref H5 "Library General (H5)" +
+Manage the life cycle of HDF5 library instances. + +- @ref H5L "Links (H5L)" +
+Manage HDF5 links and link types. + +- @ref H5O "Objects (H5O)" +
+Manage HDF5 objects (groups, datasets, datatype objects). + +- @ref H5P "Property Lists (H5P)" +
+HDF5 property lists are the main vehicle to configure the behavior of HDF5 API functions. + +- @ref H5PL "Dynamically-loaded Plugins (H5PL)" +
+Manage the loading behavior of HDF5 plugins. + +- @ref H5R "References (H5R)" +
+Manage HDF5 references (HDF5 objects, attributes, and selections on datasets a.k.a. dataset regions). + +- @ref H5VL "VOL Connector (H5VL)" +
+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 @@ +Fortran Library + +- @ref FH5A "Attributes (H5A)" +
+HDF5 attribute is a small metadata object describing the nature and/or intended usage of a primary data object. + +- @ref FH5D "Datasets (H5D)" +
+Manage HDF5 datasets, including the transfer of data between memory and disk and the description of dataset properties. + +- @ref FH5S "Dataspaces (H5S)" +
+HDF5 dataspaces describe the shape of datasets in memory or in HDF5 files. + +- @ref FH5T "Datatypes (H5T)" +
+HDF5 datatypes describe the element type of HDF5 datasets and attributes. + +- @ref FH5E "Error Handling (H5E)" +
+HDF5 library error reporting. + +- @ref FH5F "Files (H5F)" +
+Manage HDF5 files. + +- @ref FH5Z "Filters (H5Z)" +
+Manage HDF5 user-defined filters + +- @ref FH5G "Groups (H5G)" +
+Manage HDF5 groups. + +- @ref FH5I "Identifiers (H5I)" +
+Manage identifiers defined by the HDF5 library. + +- @ref FH5 "Library General (H5)" +
+Manage the life cycle of HDF5 library instances. + +- @ref FH5L "Links (H5L)" +
+Manage HDF5 links and link types. + +- @ref FH5O "Objects (H5O)" +
+Manage HDF5 objects (groups, datasets, datatype objects). + +- @ref FH5P "Property Lists (H5P)" +
+HDF5 property lists are the main vehicle to configure the behavior of HDF5 API functions. + +- @ref FH5R "References (H5R)" +
+Manage HDF5 references (HDF5 objects, attributes, and selections on datasets a.k.a. dataset regions). + +- @ref FH5LT "High Level Lite (H5LT)" +
+Functions to simplify creating and manipulating datasets, attributes and other features + +- @ref FH5IM "High Level Image (H5IM)" +
+Creating and manipulating HDF5 datasets intended to be interpreted as images + +- @ref FH5TB "High Level Table (H5TB)" +
+Creating and manipulating HDF5 datasets intended to be interpreted as tables + +- @ref FH5DS "High Level Dimension Scale (H5DS)" +
+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 @@ +High-level library +
+The high-level HDF5 library includes several sets of convenience and standard-use APIs to +facilitate common HDF5 operations. + +- @ref H5LT +
+Functions to simplify creating and manipulating datasets, attributes and other features + +- @ref H5IM +
+Creating and manipulating HDF5 datasets intended to be interpreted as images + +- @ref H5TB +
+Creating and manipulating HDF5 datasets intended to be interpreted as tables + +- @ref H5PT +
+Creating and manipulating HDF5 datasets to support append- and read-only operations on table data + +- @ref H5DS +
+Creating and manipulating HDF5 datasets that are associated with the dimension of another HDF5 dataset + +- @ref H5DO +
+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 @@ +Java Library + @ref HDF5LIB + +- @ref JH5 +
+This package is the Java interface for the HDF5 library. + +- @ref JH5A +
+This package is the Java interface for the HDF5 library attribute APIs. + +- @ref JH5D +
+This package is the Java interface for the HDF5 library dataset APIs. + +- @ref JH5S +
+This package is the Java interface for the HDF5 library dataspace APIs. + +- @ref JH5T +
+This package is the Java interface for the HDF5 library datatype APIs. + +- @ref JH5E +
+This package is the Java interface for the HDF5 library error APIs. + +- @ref JH5F +
+This package is the Java interface for the HDF5 library file APIs. + +- @ref JH5Z +
+This package is the Java interface for the HDF5 library filter APIs. + +- @ref JH5G +
+This package is the Java interface for the HDF5 library group APIs. + +- @ref JH5I +
+This package is the Java interface for the HDF5 library identifier APIs. + +- @ref JH5L +
+This package is the Java interface for the HDF5 library links APIs. + +- @ref JH5O +
+This package is the Java interface for the HDF5 library object APIs. + +- @ref JH5P +
+This package is the Java interface for the HDF5 library property list APIs. + +- @ref JH5PL +
+This package is the Java interface for the HDF5 library plugin APIs. + +- @ref JH5R +
+This package is the Java interface for the HDF5 library reference APIs. + +- @ref JH5VL +
+This package is the Java interface for the HDF5 library VOL connector APIs. + +- @ref HDF5CONST +
+This class contains C constants and enumerated types of HDF5 library. + +- @ref HDFNATIVE +
+This class encapsulates native methods to deal with arrays of numbers, + * converting from numbers to bytes and bytes to numbers. + +- @ref HDFARRAY +
+This is a class for handling multidimensional arrays for HDF. + +- @ref ERRORS +
+The class HDF5Exception returns errors from the Java HDF5 Interface. + \ No newline at end of file diff --git a/doxygen/examples/tables/predefinedDatatypes.dox b/doxygen/examples/tables/predefinedDatatypes.dox new file mode 100644 index 0000000..2427d0c --- /dev/null +++ b/doxygen/examples/tables/predefinedDatatypes.dox @@ -0,0 +1,629 @@ +/** Predefined Datatypes List + * +//! [predefined_ieee_datatypes_table] + + + + + + + + + + + + + + + + + + + + + + +
Predefined IEEE Floating Point Datatypes
DatatypeDescription
#H5T_IEEE_F32BE32-bit big-endian IEEE floating point
#H5T_IEEE_F32LE32-bit little-endian IEEE floating point
#H5T_IEEE_F64BE64-bit big-endian IEEE floating point
#H5T_IEEE_F64LE64-bit little-endian IEEE floating point
+//! [predefined_ieee_datatypes_table] + * + * +//! [predefined_std_datatypes_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Predefined Standard Datatypes
DatatypeDescription
#H5T_STD_I8BE8-bit big-endian signed integer (2's complement)
#H5T_STD_I8LE8-bit little-endian signed integer (2's complement)
#H5T_STD_I16BE16-bit big-endian signed integer (2's complement)
#H5T_STD_I16LE16-bit little-endian signed integer (2's complement)
#H5T_STD_I32BE32-bit big-endian signed integer (2's complement)
#H5T_STD_I32LE32-bit little-endian signed integer (2's complement)
#H5T_STD_I64BE64-bit big-endian signed integer (2's complement)
#H5T_STD_I64LE64-bit little-endian signed integer (2's complement)
#H5T_STD_U8BE8-bit big-endian unsigned integer
#H5T_STD_U8LE8-bit little-endian unsigned integer
#H5T_STD_U16BE16-bit big-endian unsigned integer
#H5T_STD_U16LE16-bit little-endian unsigned integer
#H5T_STD_U32BE32-bit big-endian unsigned integer
#H5T_STD_U32LE32-bit little-endian unsigned integer
#H5T_STD_U64BE64-bit big-endian unsigned integer
#H5T_STD_U64LE64-bit little-endian unsigned integer
#H5T_STD_B8BE8-bit big-endian bitfield
#H5T_STD_B8LE8-bit little-endian bitfield
#H5T_STD_B16BE16-bit big-endian bitfield
#H5T_STD_B16LE16-bit little-endian bitfield
#H5T_STD_B32BE32-bit big-endian bitfield
#H5T_STD_B32LE32-bit little-endian bitfield
#H5T_STD_B64BE64-bit big-endian bitfield
#H5T_STD_B64LE64-bit little-endian bitfield
#H5T_STD_REF_OBJObject reference
#H5T_STD_REF_DSETREGDataset region reference
#H5T_STD_REFGeneric reference
+//! [predefined_std_datatypes_table] + * + * +//! [predefined_unix_datatypes_table] + + + + + + + + + + + + + + + + + + + + + + +
Predefined UNIX-specific Datatypes
DatatypeDescription
#H5T_UNIX_D32BE32-bit big-endian
#H5T_UNIX_D32LE32-bit little-endian
#H5T_UNIX_D64BE64-bit big-endian
#H5T_UNIX_D64LE64-bit little-endian
+//! [predefined_unix_datatypes_table] + * + * +//! [predefined_string_datatypes_table] + + + + + + + + + + + + + + + +
Predefined String Datatypes
DatatypeDescription
#H5T_C_S1String datatype in C (size defined in bytes rather than in bits)
#H5T_FORTRAN_S1String datatype in Fortran (as defined for the HDF5 C library)
+//! [predefined_string_datatypes_table] + * + * +//! [predefined_intel_datatypes_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Predefined Intel-specific Datatypes
DatatypeDescription
#H5T_INTEL_I88-bit little-endian signed integer (2's complement)
#H5T_INTEL_I1616-bit little-endian signed integer (2's complement)
#H5T_INTEL_I3232-bit little-endian signed integer (2's complement)
#H5T_INTEL_I6464-bit little-endian signed integer (2's complement)
#H5T_INTEL_U88-bit little-endian unsigned integer
#H5T_INTEL_U1616-bit little-endian unsigned integer
#H5T_INTEL_U3232-bit little-endian unsigned integer
#H5T_INTEL_U6464-bit little-endian unsigned integer
#H5T_INTEL_B88-bit little-endian bitfield
#H5T_INTEL_B1616-bit little-endian bitfield
#H5T_INTEL_B3232-bit little-endian bitfield
#H5T_INTEL_B6464-bit little-endian bitfield
#H5T_INTEL_F3232-bit little-endian IEEE floating point
#H5T_INTEL_F6464-bit little-endian IEEE floating point
+//! [predefined_intel_datatypes_table] + * + * +//! [predefined_dec_datatypes_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Predefined DEC Alpha-specific Datatypes
DatatypeDescription
#H5T_ALPHA_I88-bit little-endian signed integer (2's complement)
#H5T_ALPHA_I1616-bit little-endian signed integer (2's complement)
#H5T_ALPHA_I3232-bit little-endian signed integer (2's complement)
#H5T_ALPHA_I6464-bit little-endian signed integer (2's complement)
#H5T_ALPHA_U88-bit little-endian unsigned integer
#H5T_ALPHA_U1616-bit little-endian unsigned integer
#H5T_ALPHA_U3232-bit little-endian unsigned integer
#H5T_ALPHA_U6464-bit little-endian unsigned integer
#H5T_ALPHA_B88-bit little-endian bitfield
#H5T_ALPHA_B1616-bit little-endian bitfield
#H5T_ALPHA_B3232-bit little-endian bitfield
#H5T_ALPHA_B6464-bit little-endian bitfield
#H5T_ALPHA_F3232-bit little-endian IEEE floating point
#H5T_ALPHA_F6464-bit little-endian IEEE floating point
+//! [predefined_dec_datatypes_table] + * + * +//! [predefined_openvms_datatypes_table] + + + + + + + + + + + + + + +
Predefined OpenVMS DEC Alpha-specific Datatypes
DatatypeDescription
#H5T_VAX_F3232-bit floating point (Corresponds to F_Floating type)
#H5T_VAX_F6464-bit floating point (Corresponds to G_Floating type)
+//! [predefined_openvms_datatypes_table] + * + * +//! [predefined_mips_datatypes_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Predefined MIPS-specific Datatypes
DatatypeDescription
#H5T_MIPS_I88-bit big-endian signed integer (2's complement)
#H5T_MIPS_I1616-bit big-endian signed integer (2's complement)
#H5T_MIPS_I3232-bit big-endian signed integer (2's complement)
#H5T_MIPS_I6464-bit big-endian signed integer (2's complement)
#H5T_MIPS_U88-bit big-endian unsigned integer
#H5T_MIPS_U1616-bit big-endian unsigned integer
#H5T_MIPS_U3232-bit big-endian unsigned integer
#H5T_MIPS_U6464-bit big-endian unsigned integer
#H5T_MIPS_B88-bit big-endian bitfield
#H5T_MIPS_B1616-bit big-endian bitfield
#H5T_MIPS_B3232-bit big-endian bitfield
#H5T_MIPS_B6464-bit big-endian bitfield
#H5T_MIPS_F3232-bit big-endian IEEE floating point
#H5T_MIPS_F6464-bit big-endian IEEE floating point
+//! [predefined_mips_datatypes_table] + * + * +//! [predefined_native_datatypes_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Predefined Native Datatypes
DatatypeDescription
#H5T_NATIVE_CHARC-style char
#H5T_NATIVE_SCHARC-style signed char
#H5T_NATIVE_UCHARC-style unsigned signed char
#H5T_NATIVE_SHORTC-style short
#H5T_NATIVE_USHORTC-style unsigned short
#H5T_NATIVE_INTC-style int
#H5T_NATIVE_UINTC-style unsigned int
#H5T_NATIVE_LONGC-style long
#H5T_NATIVE_ULONGC-style unsigned long
#H5T_NATIVE_LLONGC-style long long
#H5T_NATIVE_ULLONGC-style unsigned long long
#H5T_NATIVE_FLOATC-style float
#H5T_NATIVE_DOUBLEC-style double
#H5T_NATIVE_LDOUBLEC-style long double
#H5T_NATIVE_B88-bit bitfield based on native types
#H5T_NATIVE_B1616-bit bitfield based on native types
#H5T_NATIVE_B3232-bit bitfield based on native types
#H5T_NATIVE_B6464-bit bitfield based on native types
#H5T_NATIVE_OPAQUEopaque unit based on native types
#H5T_NATIVE_HADDRaddress type based on native types
#H5T_NATIVE_HSIZEsize type based on native types
#H5T_NATIVE_HSSIZEsigned size type based on native types
#H5T_NATIVE_HERRerror code type based on native types
#H5T_NATIVE_HBOOLBoolean type based on native types
+//! [predefined_native_datatypes_table] + * + * +//! [predefined_c9x_datatypes_table] + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Predefined ANSI C9x-specific Native Integer Datatypes
DatatypeDescription
#H5T_NATIVE_INT88-bit signed integer (2's complement)
#H5T_NATIVE_UINT88-bit unsigned integer
#H5T_NATIVE_INT_LEAST88-bit signed integer (2's complement) with storage to use least amount of space
#H5T_NATIVE_UINT_LEAST88-bit unsigned integer with storage to use least amount of space
#H5T_NATIVE_INT_FAST88-bit signed integer (2's complement) with storage to maximize performance
#H5T_NATIVE_UINT_FAST88-bit unsigned integer with storage to maximize performance
#H5T_NATIVE_INT1616-bit signed integer (2's complement)
#H5T_NATIVE_UINT1616-bit unsigned integer
#H5T_NATIVE_INT_LEAST1616-bit signed integer (2's complement) with storage to use least amount of space
#H5T_NATIVE_UINT_LEAST1616-bit unsigned integer with storage to use least amount of space
#H5T_NATIVE_INT_FAST1616-bit signed integer (2's complement) with storage to maximize performance
#H5T_NATIVE_UINT_FAST1616-bit unsigned integer with storage to maximize performance
#H5T_NATIVE_INT3232-bit signed integer (2's complement)
#H5T_NATIVE_UINT3232-bit unsigned integer
#H5T_NATIVE_INT_LEAST3232-bit signed integer (2's complement) with storage to use least amount of space
#H5T_NATIVE_UINT_LEAST3232-bit unsigned integer with storage to use least amount of space
#H5T_NATIVE_INT_FAST3232-bit signed integer (2's complement) with storage to maximize performance
#H5T_NATIVE_UINT_FAST3232-bit unsigned integer with storage to maximize performance
#H5T_NATIVE_INT6464-bit signed integer (2's complement)
#H5T_NATIVE_UINT6464-bit unsigned integer
#H5T_NATIVE_INT_LEAST6464-bit signed integer (2's complement) with storage to use least amount of space
#H5T_NATIVE_UINT_LEAST6464-bit unsigned integer with storage to use least amount of space
#H5T_NATIVE_INT_FAST6464-bit signed integer (2's complement) with storage to maximize performance
#H5T_NATIVE_UINT_FAST6464-bit unsigned integer with storage to maximize performance
+//! [predefined_c9x_datatypes_table] + * + */ diff --git a/doxygen/hdf5doxy_layout.xml b/doxygen/hdf5doxy_layout.xml index f7c47bf..588052b 100644 --- a/doxygen/hdf5doxy_layout.xml +++ b/doxygen/hdf5doxy_layout.xml @@ -6,7 +6,6 @@ - diff --git a/src/H5Tmodule.h b/src/H5Tmodule.h index f631007..bc521f1 100644 --- a/src/H5Tmodule.h +++ b/src/H5Tmodule.h @@ -3871,26 +3871,6 @@ filled according to the value of this property. The padding can be: * to HDF5 files and linked to groups as HDF5 datatype objects or so-called * \Emph{committed datatypes}. * - * - * - * - * - * - * - * - * - * - * - *
CreateRead
- * \snippet{lineno} H5T_examples.c create - * - * \snippet{lineno} H5T_examples.c read - *
UpdateDelete
- * \snippet{lineno} H5T_examples.c update - * - * \snippet{lineno} H5T_examples.c delete - *
- * * \defgroup ARRAY Array Datatypes * \ingroup H5T * \defgroup ATOM Atomic Datatypes @@ -3911,33 +3891,36 @@ filled according to the value of this property. The padding can be: * * \defgroup PDT Predefined Datatypes * \ingroup H5T - * \details What is a predefined HDF5 datatype? - * \todo Fill in the blanks! * * \defgroup PDTCPU By CPU * \ingroup PDT * \details CPU-specific datatypes * \defgroup PDTALPHA DEC Alpha * \ingroup PDTCPU + * \snippet{doc} tables/predefinedDatatypes.dox predefined_dec_datatypes_table * \defgroup PDTX86 AMD & INTEL * \ingroup PDTCPU + * \snippet{doc} tables/predefinedDatatypes.dox predefined_intel_datatypes_table * \defgroup PDTMIPS SGI MIPS * \ingroup PDTCPU + * \snippet{doc} tables/predefinedDatatypes.dox predefined_mips_datatypes_table * * \defgroup PDTIEEE IEEE * \ingroup PDT * \details The IEEE floating point types in big- and little-endian byte orders. + * \snippet{doc} tables/predefinedDatatypes.dox predefined_ieee_datatypes_table * * \defgroup PDTSTD Standard Datatypes * \ingroup PDT * \details These are "standard" types. For instance, signed (2's complement) * and unsigned integers of various sizes in big- and little-endian * byte orders. + * \snippet{doc} tables/predefinedDatatypes.dox predefined_std_datatypes_table * * \defgroup PDTUNIX UNIX-specific Datatypes * \ingroup PDT * \details Types which are particular to Unix. - * \todo Fill in the blanks! + * \snippet{doc} tables/predefinedDatatypes.dox predefined_unix_datatypes_table * * \defgroup PDTNAT Native Datatypes * \ingroup PDT @@ -3951,13 +3934,16 @@ filled according to the value of this property. The padding can be: * \li The datatype \c LLONG corresponds C's \Code{long long} and * \c LDOUBLE is \Code{long double}. These types might be the same * as \c LONG and \c DOUBLE, respectively. + * \snippet{doc} tables/predefinedDatatypes.dox predefined_native_datatypes_table + * * \defgroup PDTC9x C9x Integer Datatypes * \ingroup PDTNAT * \details C9x integer types - * \todo Fill in the blanks! + * \snippet{doc} tables/predefinedDatatypes.dox predefined_c9x_datatypes_table * * \defgroup PDTS Strings * \ingroup PDT + * \snippet{doc} tables/predefinedDatatypes.dox predefined_string_datatypes_table * */ -- cgit v0.12