Skip to content

Commit

Permalink
Fix long standing reference warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
byrnHDF committed Jan 13, 2025
1 parent 1f33f8d commit e888fcb
Show file tree
Hide file tree
Showing 7 changed files with 30 additions and 32 deletions.
2 changes: 1 addition & 1 deletion doxygen/dox/H5.format.1.1.dox
Original file line number Diff line number Diff line change
Expand Up @@ -3246,7 +3246,7 @@ applied to the data stream by providing filter identification numbers, flags, a
\anchor FMT11Footnote1Change <sup>1</sup> If you are reading an earlier version of this document, this
link may have changed. If the link does not work, use the latest version of this document on
<a href="https://github.com/HDFGroup/hdf5">The HDF Group</a>&rsquo;s github website,
<a href="https://\DOXURL/_s_p_e_c.html">HDF5 File Format Specification</a>; the link there will always be correct.
\ref SPEC; the link there will always be correct.

\subsubsection subsubsec_fmt11_dataobject_hdr_attribute Name: Attribute
<strong>Header Message Type:</strong> 0x000C<br />
Expand Down
2 changes: 1 addition & 1 deletion doxygen/dox/H5.format.2.0.dox
Original file line number Diff line number Diff line change
Expand Up @@ -7609,7 +7609,7 @@ Class-specific information for chunked layout (Class 2):
\anchor FMT2Footnote1Change <sup>1</sup> If you are reading an earlier version of this document, this
link may have changed. If the link does not work, use the latest version of this document on
<a href="https://github.com/HDFGroup/hdf5">The HDF Group</a>&rsquo;s github website,
<a href="https://\DOXURL/_s_p_e_c.html">HDF5 File Format Specification</a>; the link there will always be correct.
\ref SPEC; the link there will always be correct.

<table>
<caption align="top"><strong>Filter Pipeline Message - Version 2</strong></caption>
Expand Down
2 changes: 1 addition & 1 deletion doxygen/dox/H5.format.3.0.dox
Original file line number Diff line number Diff line change
Expand Up @@ -8592,7 +8592,7 @@ The following information exists only when the chunk is filtered. In other words
\anchor FMT3Footnote1Change <sup>1</sup> If you are reading an earlier version of this document, this
link may have changed. If the link does not work, use the latest version of this document on
<a href="https://github.com/HDFGroup/hdf5">The HDF Group</a>&rsquo;s github website,
<a href="https://\DOXURL/_s_p_e_c.html">HDF5 File Format Specification</a>; the link there will always be correct.
\ref SPEC; the link there will always be correct.

<table>
<caption align="top"><strong>Layout: Filter Pipeline Message - Version 2</strong></caption>
Expand Down
2 changes: 1 addition & 1 deletion doxygen/examples/tables/fileDriverLists.dox
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@
*
//! [supported_file_driver_table]
<table>
<caption id="table_file_drivers">Supported file drivers</caption>
<caption>Supported file drivers</caption>
<tr>
<th>Driver Name</th>
<th>Driver Identifier</th>
Expand Down
32 changes: 16 additions & 16 deletions doxygen/examples/tables/propertyLists.dox
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
*
//! [plcr_table]
<table>
<caption id="table_plcr_id" border="1" style="background-color:whitesmoke;">Property list class root functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">Property list class root functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand Down Expand Up @@ -32,7 +32,7 @@
*
//! [plcra_table]
<table>
<caption id="table_plcra_id" border="1" style="background-color:whitesmoke;">Property list class root (Advanced) functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">Property list class root (Advanced) functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand Down Expand Up @@ -102,7 +102,7 @@
*
//! [fcpl_table]
<table>
<caption id="table_fcpl_id" border="1" style="background-color:whitesmoke;">File creation property list functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">File creation property list functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand Down Expand Up @@ -157,7 +157,7 @@ creation property list.</td>
*
//! [fapl_table]
<table>
<caption id="table_fapl_id" border="1" style="background-color:whitesmoke;">File access property list functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">File access property list functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand Down Expand Up @@ -298,7 +298,7 @@ versions used when creating objects.</td>
*
//! [fd_pl_table]
<table>
<caption id="table_fd_pl_id" border="1" style="background-color:whitesmoke;">File driver property list functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">File driver property list functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand Down Expand Up @@ -418,7 +418,7 @@ and one raw data file.</td>
*
//! [dcpl_table]
<table>
<caption id="table_dcpl_id" border="1" style="background-color:whitesmoke;">Dataset creation property list functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">Dataset creation property list functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand Down Expand Up @@ -579,7 +579,7 @@ encoding for object names.</td>
*
//! [dapl_table]
<table>
<caption id="table_dapl_id" border="1" style="background-color:whitesmoke;">Dataset access property list functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">Dataset access property list functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand Down Expand Up @@ -621,7 +621,7 @@ encoding for object names.</td>
*
//! [dxpl_table]
<table>
<caption id="table_dxpl_id" border="1" style="background-color:whitesmoke;">Data transfer property list functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">Data transfer property list functions (H5P)</caption>
<tr>
<th>C Function</th>
<th>Purpose</th>
Expand Down Expand Up @@ -727,7 +727,7 @@ of the library for reading or writing the actual data.</td>
*
//! [gcpl_table]
<table>
<caption id="table_gcpl_id">Group creation property list functions (H5P)</caption>
<caption>Group creation property list functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand Down Expand Up @@ -820,7 +820,7 @@ encoding for object names.</td>
*
//! [gapl_table]
<table>
<caption id="table_gapl_id" border="1" style="background-color:whitesmoke;">Group access property list functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">Group access property list functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand All @@ -834,7 +834,7 @@ encoding for object names.</td>
*
//! [lapl_table]
<table>
<caption id="table_lapl_id" border="1" style="background-color:whitesmoke;">Link access property list functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">Link access property list functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand Down Expand Up @@ -864,7 +864,7 @@ encoding for object names.</td>
*
//! [ocpl_table]
<table>
<caption id="table_ocpl_id" border="1" style="background-color:whitesmoke;">Object creation property list functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">Object creation property list functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand Down Expand Up @@ -910,7 +910,7 @@ encoding for object names.</td>
*
//! [ocpypl_table]
<table>
<caption id="table_ocpypl_id" border="1" style="background-color:whitesmoke;">Object copy property list functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">Object copy property list functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand All @@ -936,7 +936,7 @@ encoding for object names.</td>
*
//! [strcpl_table]
<table>
<caption id="table_strcpl_id" border="1" style="background-color:whitesmoke;">String creation property list functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">String creation property list functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand All @@ -950,7 +950,7 @@ encoding for object names.</td>
*
//! [lcpl_table]
<table>
<caption id="table_lcpl_id" border="1" style="background-color:whitesmoke;">Link creation property list functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">Link creation property list functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand All @@ -964,7 +964,7 @@ encoding for object names.</td>
*
//! [acpl_table]
<table>
<caption id="table_acpl_id" border="1" style="background-color:whitesmoke;">Attribute creation property list functions (H5P)</caption>
<caption border="1" style="background-color:whitesmoke;">Attribute creation property list functions (H5P)</caption>
<tr>
<th>Function</th>
<th>Purpose</th>
Expand Down
7 changes: 4 additions & 3 deletions src/H5Fmodule.h
Original file line number Diff line number Diff line change
Expand Up @@ -679,6 +679,7 @@
* systems, environments, and applications. The drivers are listed in the table below.
*
* <div>
* \subsubsection table_file_drivers Supported file drivers
* \snippet{doc} tables/fileDriverLists.dox supported_file_driver_table
* </div>
*
Expand Down Expand Up @@ -713,7 +714,7 @@
* If the application opens an HDF5 file without both determining the driver used to create the file
* and setting up the use of that driver, the HDF5 Library will examine the superblock and the
* driver definition block to identify the driver.
* See the <a href="https://\DOXURL/_s_p_e_c.html">HDF5 File Format Specification</a>
* See the \ref_spec_fileformat
* for detailed descriptions of the superblock and the driver definition block.
*
* \subsubsection subsubsec_file_alternate_drivers_sec2 The POSIX (aka SEC2) Driver
Expand Down Expand Up @@ -2557,7 +2558,7 @@
* \subsection subsec_file_image_fort Fortran Signatures for File Image Operations API Calls
* Fortran function call signatures for the file image operation APIs are described in this section.
*
* \subsubsection subsubsec_file_image_fort_low
* \subsubsection subsubsec_file_image_fort_low Fortran Low-Level APIs
* The Fortran low-level APIs make use of Fortran 2003’s ISO_C_BINDING module in order to achieve portable
* and standard conforming interoperability with the C APIs. The C pointer (C_PTR) and function pointer
* (C_FUN_PTR) types are returned from the intrinsic procedures C_LOC(X) and C_FUNLOC(X), respectively,
Expand Down Expand Up @@ -2609,7 +2610,7 @@
* </td></tr>
* </table>
*
* \subsubsection subsubsec_file_image_fort_high
* \subsubsection subsubsec_file_image_fort_high Fortran High-Level APIs
* Fortran function call signatures for the file image operation APIs have not yet been implemented yet.
*
* Previous Chapter \ref sec_vol - Next Chapter \ref sec_async
Expand Down
15 changes: 6 additions & 9 deletions src/H5module.h
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,7 @@
* The <em>Abstract Data Model</em> is a conceptual model of data, data types, and data organization. The
* abstract data model is independent of storage medium or programming environment. The
* <em>Storage Model</em> is a standard representation for the objects of the abstract data model. The
* <a href="https://\DOXURL/_s_p_e_c.html">HDF5 File Format Specification</a>
* defines the storage model.
* \ref_spec_fileformat defines the storage model.
*
* The <em>Programming Model</em> is a model of the computing environment and includes platforms from
* small single systems to large multiprocessors and clusters. The programming model manipulates
Expand Down Expand Up @@ -104,7 +103,7 @@
* blocks.
*
* For more information on how these objects are organized;
* see <a href="https://\DOXURL/_s_p_e_c.html">HDF5 File Format Specification</a>
* see \ref_spec_fileformat
*
* The HDF5 library can also use other
* libraries and modules such as compression.
Expand All @@ -129,8 +128,7 @@
* Specification. The organization of the data of application program, and how it is mapped to the
* HDF5 abstract data model is up to the application developer. The application program only
* needs to deal with the library and the abstract data model. Most applications need not consider
* any details of the
* <a href="https://\DOXURL/_s_p_e_c.html">HDF5 File Format Specification</a>
* any details of the \ref_spec_fileformat
* or the details of how objects of abstract data model are translated to and from storage.
*
* \subsection subsec_data_model_abstract The Abstract Data Model
Expand Down Expand Up @@ -413,15 +411,14 @@
*
* \subsection subsec_data_model_storage The HDF5 Storage Model
* \subsubsection subsubsec_data_model_storage_spec The Abstract Storage Model: the HDF5 Format Specification
* The <a href="https://\DOXURL/_s_p_e_c.html">HDF5 File Format Specification</a>
* defines how HDF5 objects and data are mapped to a linear
* The \ref_spec_fileformat defines how HDF5 objects and data are mapped to a linear
* address space. The address space is assumed to be a contiguous array of bytes stored on some
* random access medium. The format defines the standard for how the objects of the abstract data
* model are mapped to linear addresses. The stored representation is self-describing in the sense
* that the format defines all the information necessary to read and reconstruct the original objects
* of the abstract data model.
*
* The HDF5 File Format Specification is organized in three parts:
* The \ref_spec_fileformat is organized in three parts:
* <ul><li>Level 0: File signature and super block</li>
* <li>Level 1: File infrastructure</li>
* <ul><li>Level 1A: B-link trees and B-tree nodes</li>
Expand All @@ -445,7 +442,7 @@
* It is important to realize that the structures defined in the HDF5 file format are not the same as
* the abstract data model: the object headers, heaps, and B-trees of the file specification are not
* represented in the abstract data model. The format defines a number of objects for managing the
* storage including header blocks, B-trees, and heaps. The HDF5 File Format Specification defines
* storage including header blocks, B-trees, and heaps. The \ref_spec_fileformat defines
* how the abstract objects (for example, groups and datasets) are represented as headers, B-tree
* blocks, and other elements.
*
Expand Down

0 comments on commit e888fcb

Please sign in to comment.