Skip to content

Commit

Permalink
Split doxygen pages from spec and TN into files (HDFGroup#5165)
Browse files Browse the repository at this point in the history
  • Loading branch information
@byrnHDF
byrnHDF committed Dec 17, 2024
1 parent f3b3bc4 commit dec5314
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 1,147 deletions.
10 changes: 5 additions & 5 deletions doxygen/dox/GettingStarted.dox
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,15 +50,15 @@ The high-level HDF5 library includes several sets of convenience and standard-us
</tr>
<tr>
<td style="background-color:#F5F5F5">
\ref IntroParHDF5
@ref IntroParHDF5
</td>
<td>
A brief introduction to Parallel HDF5. If you are new to HDF5 please see the @ref LearnBasics topic first.
</td>
</tr>
<tr>
<td style="background-color:#F5F5F5">
\ref ViewTools
@ref ViewTools
</td>
<td>
\li @ref LearnHDFView
Expand All @@ -71,16 +71,16 @@ A brief introduction to Parallel HDF5. If you are new to HDF5 please see the @re
New Features since HDF5-1.10
</td>
<td>
\li \ref VDSTN
\li \ref SWMRTN
\li @ref VDSTN
\li @ref SWMRTN
</td>
</tr>
<tr>
<td style="background-color:#F5F5F5">
Example Programs
</td>
<td>
\ref HDF5Examples
@ref HDF5Examples
</td>
</tr>
<tr>
Expand Down
122 changes: 8 additions & 114 deletions doxygen/dox/Specifications.dox
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,145 +9,39 @@

\section File Format

\li \ref FMT1
\li \ref FMT11
\li \ref FMT2
\li \ref FMT3
\li \ref FMT1SPEC
\li \ref FMT11SPEC
\li \ref FMT2SPEC
\li \ref FMT3SPEC

\section Other

\li \ref IMG
<<<<<<< Upstream, based on branch 'develop-doxy-fformat' of https://github.com/byrnHDF/hdf5.git
\li \ref TBLSPEC
\li \ref sec_dim_scales_spec
=======
\li \ref TBL
\li <a href="https://\DOCURL/hdf5_topics/H5DS_Spec.pdf">
HDF5 Dimension Scale Specification</a>

*/

/** \page FMT3 HDF5 File Format Specification Version 3.0
/** \page FMT3SPEC HDF5 File Format Specification Version 3.0

\htmlinclude H5.format.html

*/

/** \page FMT2 HDF5 File Format Specification Version 2.0
/** \page FMT2SPEC HDF5 File Format Specification Version 2.0

\htmlinclude H5.format.2.0.html

*/

/** \page FMT11 HDF5 File Format Specification Version 1.1
/** \page FMT11SPEC HDF5 File Format Specification Version 1.1

\htmlinclude H5.format.1.1.html

*/

/** \page FMT1 HDF5 File Format Specification Version 1.0
/** \page FMT1SPEC HDF5 File Format Specification Version 1.0

\htmlinclude H5.format.1.0.html

*/

/** \page TBL HDF5 Table Specification Version 1.0
The HDF5 specification defines the standard objects and storage for the standard HDF5
objects. (For information about the HDF5 library, model and specification, see the HDF
documentation.) This document is an additional specification do define a standard profile
for how to store tables in HDF5. Table data in HDF5 is stored as HDF5 datasets with standard
attributes to define the properties of the tables.

\section sec_tab_spec_intro Introduction
A generic table is a sequence of records, each record has a name and a type. Table data
is stored as an HDF5 one dimensional compound dataset. A table is defined as a collection
of records whose values are stored in fixed-length fields. All records have the same structure
and all values in each field have the same data type.

The dataset for a table is distinguished from other datasets by giving it an attribute
"CLASS=TABLE". Optional attributes allow the storage of a title for the Table and for
each column, and a fill value for each column.

\section sec_tab_spec_attr Table Attributes
The attributes for the Table are strings. They are written with the #H5LTset_attribute_string
Lite API function. "Required" attributes must always be used. "Optional" attributes must be
used when required.
<table>
<caption><b>Table 1. Attributes of an Image Dataset</b></caption>
<tr>
<th><b>Attribute Name</b></th>
<th><b>Required</b><br /><b>Optional</b></th>
<th><b>Type</b></th>
<th><b>String Size</b></th>
<th><b>Value</b></th>
<th><b>Description</b></th>
</tr>
<tr>
<td>CLASS</td>
<td>Required</td>
<td>String</td>
<td>5</td>
<td>&quot;TABLE&quot;</td>
<td>This attribute is type #H5T_C_S1, with size 5. For all Tables, the value of this attribute is
<b>TABLE</b>. This attribute identifies this data set as intended to be interpreted as Table that
conforms to the specifications on this page.</td>
</tr>
<tr>
<td>VERSION</td>
<td>Required</td>
<td>String</td>
<td>3</td>
<td>&quot;0.2&quot;</td>
<td>This attribute is of type #H5T_C_S1, with size corresponding to the length of the version string.
This attribute identifies the version number of this specification to which it conforms. The current
version number is "0.2".</td>
</tr>
<tr>
<td>TITLE</td>
<td>Optional</td>
<td>String</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>The <b>TITLE</b> is an optional String that is to be used as the informative title of the whole table.
The <b>TITLE</b> is set with the parameter table_title of the function #H5TBmake_table.</td>
</tr>
<tr>
<td>FIELD_(n)_NAME</td>
<td>Required</td>
<td>String</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>The <b>FIELD_(n)_NAME</b> is an optional String that is to be used as the informative title of column n
of the table. For each of the fields the word <b>FIELD_</b> is concatenated with the zero based field (n)
index together with the name of the field.</td>
</tr>
<tr>
<td>FIELD_(n)_FILL</td>
<td>Optional</td>
<td>String</td>
<td>&nbsp;</td>
<td>&nbsp;</td>
<td>The <b>FIELD_(n)_FILL</b> is an optional String that is the fill value for column n of the table.
For each of the fields the word <b>FIELD_</b> is concatenated with the zero based field (n) index
together with the fill value, if present. This value is written only when a fill value is defined
for the table.</td>
</tr>
</table>

The following section of code shows the calls necessary to the creation of a table.
\code
// Create a new HDF5 file using default properties.
file_id = H5Fcreate("my_table.h5", H5F_ACC_TRUNC, H5P_DEFAULT, H5P_DEFAULT);

// Call the make table function
H5TBmake_table("Table Title", file_id, "Table1", NFIELDS, NRECORDS, dst_size, field_names, dst_offset, field_type, chunk_size, fill_data, compress, p_data);

// Close the file.
status = H5Fclose(file_id);
\endcode

For more information see the @ref H5TB reference manual page and the @ref H5TB_UG, which includes examples.

>>>>>>> c7cb5ae Convert ImageSpec html file to doxygen (#5163)

*/
Loading

0 comments on commit dec5314

Please sign in to comment.