Use doxygen snippets for common tables (#2104)

1 files changed, 8 insertions, 290 deletions

diff --git a/src/H5Fmodule.h b/src/H5Fmodule.h
index 867ef0e..2d02e2f 100644
--- a/src/H5Fmodule.h
+++ b/src/H5Fmodule.h
@@ -410,204 +410,15 @@
  * </tr>
  * </table>
  *
- * <table>
- * <caption>File creation property list functions </caption>
- * <tr>
- * <th>Function</th>
- * <th>Purpose</th>
- * </tr>
- * <tr>
- * <td>#H5Pset_userblock/#H5Pget_userblock</td>
- * <td>Sets/retrieves size of userblock.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_sizes/#H5Pget_sizes</td>
- * <td>Sets/retrieves byte size of offsets and lengths used to address objects in HDF5 file.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_sym_k/#H5Pget_sym_k</td>
- * <td>Sets/retrieves size of parameters used to control symbol table nodes.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_istore_k/#H5Pget_istore_k</td>
- * <td>Sets/retrieves size of parameter used to control B-trees for indexing chunked datasets.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_file_image</td>
- * <td>Sets an initial file image in a memory buffer.</td>
- * </tr>
- * <tr>
- * <td>#H5Pget_file_image</td>
- * <td>Retrieves a copy of the file image designated as the initial content and structure of a file.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_shared_mesg_nindexes/#H5Pget_shared_mesg_nindexes</td>
- * <td>Sets or retrieves number of shared object header message indexes in file
- * creation property list.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_shared_mesg_index</td>
- * <td>Configures the specified shared object header message index.</td>
- * </tr>
- * <tr>
- * <td>#H5Pget_shared_mesg_index</td>
- * <td>Retrieves the configuration settings for a shared message index.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_shared_mesg_phase_change/#H5Pget_shared_mesg_phase_change</td>
- * <td>Sets or retrieves shared object header message storage phase change thresholds.</td>
- * </tr>
- * <tr>
- * <td>#H5Pget_version</td>
- * <td></td>
- * </tr>
- * </table>
+ * \anchor fcpl_table_tag File creation property list functions (H5P)
+ * \snippet{doc} tables/propertyLists.dox fcpl_table
  *
- * <table>
- * <caption>File access property list functions </caption>
- * <tr>
- * <th>Function</th>
- * <th>Purpose</th>
- * </tr>
- * <tr>
- * <td>#H5Pset_alignment/#H5Pget_alignment</td>
- * <td>Sets/retrieves alignment properties.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_cache/#H5Pget_cache</td>
- * <td>Sets/retrieves metadata cache and raw data chunk cache parameters.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_elink_file_cache_size/#H5Pget_elink_file_cache_size</td>
- * <td>Sets/retrieves the size of the external link open file cache from the specified
- * file access property list.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_gc_references/#H5Pget_gc_references</td>
- * <td>Sets/retrieves garbage collecting references flag.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_family_offset</td>
- * <td>Sets offset property for low-level access to a file in a family of files.</td>
- * </tr>
- * <tr>
- * <td>#H5Pget_family_offset</td>
- * <td>Retrieves a data offset from the file access property list.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_meta_block_size/#H5Pget_meta_block_size</td>
- * <td>Sets the minimum metadata blocksize or retrieves the current metadata block size setting.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_mdc_config</td>
- * <td>Set the initial metadata cache configuration in the indicated File Access Property List
- * to the supplied value.</td>
- * </tr>
- * <tr>
- * <td>#H5Pget_mdc_config</td>
- * <td>Get the current initial metadata cache config-uration from the indicated File Access
- * Property List.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_sieve_buf_size/#H5Pget_sieve_buf_size</td>
- * <td>Sets/retrieves maximum size of data sieve buffer.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_libver_bounds</td>
- * <td>Sets bounds on library versions, and indirectly format versions, to be used
- * when creating objects.</td>
- * </tr>
- * <tr>
- * <td>#H5Pget_libver_bounds</td>
- * <td>Retrieves library version bounds settings that indirectly control the format
- * versions used when creating objects.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_small_data_block_size</td>
- * <td>Sets the size of a contiguous block reserved for small data.</td>
- * </tr>
- * <tr>
- * <td>#H5Pget_small_data_block_size</td>
- * <td>Retrieves the current small data block size setting.</td>
- * </tr>
- * </table>
+ * \anchor fapl_table_tag File access property list functions (H5P)
+ * \snippet{doc} tables/propertyLists.dox fapl_table
+ *
+ * \anchor fd_pl_table_tag File driver property list functions (H5P)
+ * \snippet{doc} tables/propertyLists.dox fd_pl_table
  *
- * <table>
- * <caption>File driver functions </caption>
- * <tr>
- * <th>Function</th>
- * <th>Purpose</th>
- * </tr>
- * <tr>
- * <td>#H5Pset_driver</td>
- * <td>Sets a file driver.</td>
- * </tr>
- * <tr>
- * <td>#H5Pget_driver</td>
- * <td>Returns the identifier for the driver used to create a file.</td>
- * </tr>
- * <tr>
- * <td>#H5Pget_driver_info</td>
- * <td>Returns a pointer to file driver information.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_fapl_core/#H5Pget_fapl_core</td>
- * <td>Sets the driver for buffered memory files (in RAM) or retrieves information regarding
- * the driver.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_fapl_direct/#H5Pget_fapl_direct</td>
- * <td>Sets up use of the direct I/O driver or retrieves the direct I/O driver settings.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_fapl_family/#H5Pget_fapl_family</td>
- * <td>Sets driver for file families, designed for systems that do not support files
- * larger than 2 gigabytes, or retrieves information regarding driver.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_fapl_log</td>
- * <td>Sets logging driver.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_fapl_mpio/#H5Pget_fapl_mpio</td>
- * <td>Sets driver for files on parallel file systems (MPI I/O) or retrieves information
- * regarding the driver.</td>
- * </tr>
- * <tr>
- * <td>H5Pset_fapl_mpiposix/H5Pget_fapl_mpiposix</td>
- * <td>No longer available.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_fapl_multi/#H5Pget_fapl_multi</td>
- * <td>Sets driver for multiple files, separating categories of metadata and raw data,
- * or retrieves information regarding driver.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_fapl_sec2</td>
- * <td>Sets driver for unbuffered permanent files or retrieves information regarding driver.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_fapl_split</td>
- * <td>Sets driver for split files, a limited case of multiple files with one metadata file
- * and one raw data file.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_fapl_stdio</td>
- * <td>Sets driver for buffered permanent files.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_fapl_windows</td>
- * <td>Sets the Windows I/O driver.</td>
- * </tr>
- * <tr>
- * <td>#H5Pset_multi_type</td>
- * <td>Specifies type of data to be accessed via the MULTI driver enabling more direct access.</td>
- * </tr>
- * <tr>
- * <td>#H5Pget_multi_type</td>
- * <td>Retrieves type of data property for MULTI driver.</td>
- * </tr>
- * </table>
  *
  * \subsection subsec_file_create Creating or Opening an HDF5 File
  * This section describes in more detail how to create and how to open files.
@@ -864,100 +675,7 @@
  * #H5FD_SEC2. Alternative layouts and drivers are designed to suit the needs of a variety of
  * systems, environments, and applications. The drivers are listed in the table below.
  *
- * <table>
- * <caption id="table_file_drivers">Supported file drivers</caption>
- * <tr>
- * <th>Driver Name</th>
- * <th>Driver Identifier</th>
- * <th>Description</th>
- * <th>Related API</th>
- * </tr>
- * <tr>
- * <td>POSIX</td>
- * <td>#H5FD_SEC2</td>
- * <td>This driver uses POSIX file-system functions like read and write to perform I/O to a single,
- * permanent file on local disk with no system buffering. This driver is POSIX-compliant and is
- * the default file driver for all systems.</td>
- * <td>#H5Pset_fapl_sec2</td>
- * </tr>
- * <tr>
- * <td>Direct</td>
- * <td>#H5FD_DIRECT</td>
- * <td>This is the #H5FD_SEC2 driver except data is written to or read from the file
- * synchronously without being cached by the system.</td>
- * <td>#H5Pset_fapl_direct</td>
- * </tr>
- * <tr>
- * <td>Log</td>
- * <td>#H5FD_LOG</td>
- * <td>This is the #H5FD_SEC2 driver with logging capabilities.</td>
- * <td>#H5Pset_fapl_log</td>
- * </tr>
- * <tr>
- * <td>Windows</td>
- * <td>#H5FD_WINDOWS</td>
- * <td>This driver was modified in HDF5-1.8.8 to be a wrapper of the POSIX driver,
- * #H5FD_SEC2. This change should not affect user applications.</td>
- * <td>#H5Pset_fapl_windows</td>
- * </tr>
- * <tr>
- * <td>STDIO</td>
- * <td>#H5FD_STDIO</td>
- * <td>This driver uses functions from the standard C stdio.h to perform I/O
- * to a single, permanent file on local disk with additional system buffering.</td>
- * <td>#H5Pset_fapl_stdio</td>
- * </tr>
- * <tr>
- * <td>Memory</td>
- * <td>#H5FD_CORE</td>
- * <td>With this driver, an application can work with a file in memory for faster reads and
- * writes. File contents are kept in memory until the file is closed. At closing, the memory
- * version of the file can be written back to disk or abandoned.</td>
- * <td>#H5Pset_fapl_core</td>
- * </tr>
- * <tr>
- * <td>Family</td>
- * <td>#H5FD_FAMILY</td>
- * <td>With this driver, the HDF5 file’s address space is partitioned into pieces and sent to
- * separate storage files using an underlying driver of the user’s choice. This driver is for
- * systems that do not support files larger than 2 gigabytes.</td>
- * <td>#H5Pset_fapl_family</td>
- * </tr>
- * <tr>
- * <td>Multi</td>
- * <td>#H5FD_MULTI</td>
- * <td>With this driver, data can be stored in multiple files according to the type of the data.
- * I/O might work better if data is stored in separate files based on the type of data. The Split
- * driver is a special case of this driver.</td>
- * <td>#H5Pset_fapl_multi</td>
- * </tr>
- * <tr>
- * <td>Split</td>
- * <td>H5FD_SPLIT</td>
- * <td>This file driver splits a file into two parts. One part stores metadata, and the other part
- * stores raw data. This splitting a file into two parts is a limited case of the Multi driver.</td>
- * <td>#H5Pset_fapl_split</td>
- * </tr>
- * <tr>
- * <td>Parallel</td>
- * <td>#H5FD_MPIO</td>
- * <td>This is the standard HDF5 file driver for parallel file systems. This driver uses the MPI
- * standard for both communication and file I/O.</td>
- * <td>#H5Pset_fapl_mpio</td>
- * </tr>
- * <tr>
- * <td>Parallel POSIX</td>
- * <td>H5FD_MPIPOSIX</td>
- * <td>This driver is no longer available</td>
- * <td></td>
- * </tr>
- * <tr>
- * <td>Stream</td>
- * <td>H5FD_STREAM</td>
- * <td>This driver is no longer available.</td>
- * <td></td>
- * </tr>
- * </table>
+ * \snippet{doc} tables/fileDriverLists.dox supported_file_driver_table
  *
  * For more information, see the HDF5 Reference Manual entries for the function calls shown in
  * the column on the right in the table above.