Use doxygen snippets for common tables (#2104)

1 files changed, 101 insertions, 52 deletions

diff --git a/src/H5Pmodule.h b/src/H5Pmodule.h
index d5ef982..38d06e2 100644
--- a/src/H5Pmodule.h
+++ b/src/H5Pmodule.h
@@ -788,9 +788,9 @@
  * <li>\ref subsec_file_property_lists</li>
  * <li>\ref subsubsec_file_examples_props</li>
  * <li>\ref subsubsec_file_examples_access</li>
- * <li>"File creation property list functions (H5P)"</li>
- * <li>"File access property list functions (H5P)"</li>
- * <li>"File driver functions (H5P)"</li></ul>
+ * <li>\ref dcpl_table_tag "Dataset creation property list functions (H5P)"</li>
+ * <li>\ref fapl_table_tag "File access property list functions (H5P)"</li>
+ * <li>\ref fd_pl_table_tag "File driver property list functions (H5P)"</li></ul>
  * \li In the \ref sec_attribute chapter, see "Attribute creation property list functions (H5P)".
  * \li In the \ref sec_group chapter, see "Group creation property list functions (H5P)".
  * \li Property lists are discussed throughout \ref sec_dataset.
@@ -798,16 +798,16 @@
  * All property list functions are described in the \ref H5P section of the
  * \ref RM. The function index at the top of the page provides a categorized listing
  * grouped by property list class. Those classes are listed below:
- * \li File creation properties
- * \li File access properties
- * \li Group creation properties
- * \li Dataset creation properties
- * \li Dataset access properties
- * \li Dataset transfer properties
- * \li Link creation properties
- * \li Link access properties
- * \li Object creation properties
- * \li Object copy properties
+ * \li \ref FCPL
+ * \li \ref FAPL
+ * \li \ref GCPL
+ * \li \ref DCPL
+ * \li \ref DAPL
+ * \li \ref DXPL
+ * \li \ref LCPL
+ * \li \ref LAPL
+ * \li \ref OCPL
+ * \li \ref OCPYPL
  *
  * Additional categories not related to the class structure are as follows:
  * \li General property list operations
@@ -893,135 +893,184 @@
  * or writing data. Property lists can be modified by adding or changing
  * properties. Property lists are deleted by closing the associated handles.
  *
- * <table>
- * <tr><th>Create</th><th>Read</th></tr>
- * <tr valign="top">
- *   <td>
- *   \snippet{lineno} H5P_examples.c create
- *   </td>
- *   <td>
- *   \snippet{lineno} H5P_examples.c read
- *   </td>
- * <tr><th>Update</th><th>Delete</th></tr>
- * <tr valign="top">
- *   <td>
- *   \snippet{lineno} H5P_examples.c update
- *   </td>
- *   <td>
- *   \snippet{lineno} H5P_examples.c delete
- *   </td>
- * </tr>
- * </table>
+ * \ref PLCR
+ * \snippet{doc} tables/propertyLists.dox plcr_table
+ *
+ * \ref PLCR
+ * \snippet{doc} tables/propertyLists.dox plcra_table
+ *
+ * \ref PLCR / \ref OCPL / \ref GCPL
+ * \snippet{doc} tables/propertyLists.dox fcpl_table
+ *
+ * \ref PLCR
+ * \snippet{doc} tables/propertyLists.dox fapl_table
+ *
+ * \ref PLCR
+ * \snippet{doc} tables/propertyLists.dox lapl_table
+ *
+ * \ref PLCR / \ref OCPL
+ * \snippet{doc} tables/propertyLists.dox dcpl_table
+ *
+ * \ref PLCR / \ref LAPL
+ * \snippet{doc} tables/propertyLists.dox dapl_table
+ *
+ * \ref PLCR / \ref OCPL
+ * \snippet{doc} tables/propertyLists.dox gcpl_table
+ *
+ * \ref PLCR / \ref LAPL
+ * \snippet{doc} tables/propertyLists.dox gapl_table
+ *
+ * \ref PLCR
+ * \snippet{doc} tables/propertyLists.dox ocpl_table
+ *
+ * \ref PLCR
+ * \snippet{doc} tables/propertyLists.dox ocpypl_table
+ *
+ * \ref PLCR
+ * \snippet{doc} tables/propertyLists.dox strcpl_table
+ *
+ * \ref PLCR / \ref STRCPL
+ * \snippet{doc} tables/propertyLists.dox lcpl_table
+ *
+ * \ref PLCR / \ref STRCPL
+ * \snippet{doc} tables/propertyLists.dox acpl_table
+ *
  *
  * \defgroup STRCPL String Creation Properties
+ * \ingroup H5P
  * Currently, there are only two creation properties that you can use to control
  * the creation of HDF5 attributes and links. The first creation property, the
  * choice of a character encoding, applies to both attributes and links.
  * The second creation property applies to links only, and advises the library
  * to automatically create missing intermediate groups when creating new objects.
- * \ingroup H5P
+ *
+ * \snippet{doc} tables/propertyLists.dox strcpl_table
  *
  * \defgroup LCPL Link Creation Properties
- * The first creation property, the choice of a character encoding, applies to
- * both attributes and links.
- * The second creation property applies to links only, and advises the library
- * to automatically create missing intermediate groups when creating new objects.
  * \ingroup STRCPL
+ * This creation property applies to links only, and advises the library
+ * to automatically create missing intermediate groups when creating new objects.
+ *
+ * \snippet{doc} tables/propertyLists.dox lcpl_table
  *
  * @see STRCPL
  *
  * \defgroup ACPL Attribute Creation Properties
- * The creation property, the choice of a character encoding, applies to attributes.
  * \ingroup STRCPL
+ * The creation property, the choice of a character encoding, applies to attributes.
+ *
+ * \snippet{doc} tables/propertyLists.dox acpl_table
  *
  * @see STRCPL
  *
  * \defgroup LAPL Link Access Properties
  * \ingroup H5P
  *
+ * \snippet{doc} tables/propertyLists.dox lapl_table
+ *
  * \defgroup DAPL Dataset Access Properties
+ * \ingroup LAPL
  * Use dataset access properties to modify the default behavior of the HDF5
  * library when accessing datasets. The properties include adjusting the size
  * of the chunk cache, providing prefixes for external content and virtual
  * dataset file paths, and controlling flush behavior, etc. These properties
  * are \Emph{not} persisted with datasets, and can be adjusted at runtime before
  * a dataset is created or opened.
- * \ingroup LAPL
+ *
+ * \snippet{doc} tables/propertyLists.dox dapl_table
  *
  * \defgroup DCPL Dataset Creation Properties
+ * \ingroup OCPL
  * Use dataset creation properties to control aspects of dataset creation such
  * as fill time, storage layout, compression methods, etc.
  * Unlike dataset access and transfer properties, creation properties \Emph{are}
  * stored with the dataset, and cannot be changed once a dataset has been
  * created.
- * \ingroup OCPL
+ *
+ * \snippet{doc} tables/propertyLists.dox dcpl_table
  *
  * \defgroup DXPL Dataset Transfer Properties
+ * \ingroup H5P
  * Use dataset transfer properties to customize certain aspects of reading
  * and writing datasets such as transformations, MPI-IO I/O mode, error
  * detection, etc. These properties are \Emph{not} persisted with datasets,
  * and can be adjusted at runtime before a dataset is read or written.
- * \ingroup H5P
+ *
+ * \snippet{doc} tables/propertyLists.dox dxpl_table
  *
  * \defgroup FAPL File Access Properties
+ * \ingroup H5P
  * Use file access properties to modify the default behavior of the HDF5
  * library when accessing files. The properties include selecting a virtual
  * file driver (VFD), configuring the metadata cache (MDC), control
  * file locking, etc. These properties are \Emph{not} persisted with files, and
  * can be adjusted at runtime before a file is created or opened.
- * \ingroup H5P
+ *
+ * \snippet{doc} tables/propertyLists.dox fapl_table
  *
  * \defgroup FCPL File Creation Properties
+ * \ingroup GCPL
  * Use file creation properties to control aspects of file creation such
  * as setting a file space management strategy or creating a user block.
  * Unlike file access properties, creation properties \Emph{are}
  * stored with the file, and cannot be changed once a file has been
  * created.
- * \ingroup GCPL
  *
- * \defgroup GAPL General Access Properties
- * The functions in this section can be applied to different kinds of property
- * lists.
+ * \snippet{doc} tables/propertyLists.dox fcpl_table
+ *
+ * \defgroup GAPL Group Access Properties
  * \ingroup LAPL
+ * The functions in this section can be applied to group property lists.
+ *
+ * \snippet{doc} tables/propertyLists.dox gapl_table
  *
  * \defgroup GCPL Group Creation Properties
+ * \ingroup OCPL
  * Use group creation properties to control aspects of group creation such
  * as storage layout, compression, and link creation order tracking.
  * Unlike file access properties, creation properties \Emph{are}
  * stored with the group, and cannot be changed once a group has been
  * created.
- * \ingroup OCPL
+ *
+ * \snippet{doc} tables/propertyLists.dox gcpl_table
  *
  * \defgroup PLCR Property List Class Root
- * Use the functions in this module to manage HDF5 property lists.
  * \ingroup H5P
+ * Use the functions in this module to manage HDF5 property lists.
+ *
+ * \snippet{doc} tables/propertyLists.dox plcr_table
  *
  * \defgroup PLCRA Property List Class Root (Advanced)
+ * \ingroup H5P
  * You can create and customize user-defined property list classes using the
  * functions described below. Arbitrary user-defined properties can also
  * be inserted into existing property lists as so-called temporary properties.
- * \ingroup H5P
  *
+ * \snippet{doc} tables/propertyLists.dox plcra_table
  *
  * \defgroup OCPL Object Creation Properties
  * \ingroup H5P
  *
+ * \snippet{doc} tables/propertyLists.dox ocpl_table
+ *
  * \defgroup OCPYPL Object Copy Properties
  * \ingroup H5P
  *
+ * \snippet{doc} tables/propertyLists.dox ocpypl_table
+ *
  * \defgroup FMPL File Mount Properties
- * Empty property class.
  * \ingroup H5P
+ * Empty property class.
  *
  *
  * \defgroup TCPL Datatype Creation Properties
- * TCPL isn't supported yet.
  * \ingroup OCPL
+ * TCPL isn't supported yet.
  *
  *
  * \defgroup TAPL Datatype Access Properties
- * TAPL isn't supported yet.
  * \ingroup LAPL
+ * TAPL isn't supported yet.
  *
  *
  *