summaryrefslogtreecommitdiffstats
path: root/src/H5PLmodule.h
diff options
context:
space:
mode:
authorAllen Byrne <50328838+byrnHDF@users.noreply.github.com>2021-09-07 21:08:41 (GMT)
committerGitHub <noreply@github.com>2021-09-07 21:08:41 (GMT)
commitd0507c23f30fc1ff66ae4a31d41f681612e51851 (patch)
tree18032d7c438334900adf45d22659b70cee072215 /src/H5PLmodule.h
parentf5709db18e10993de3bc4668ad07b66d14279877 (diff)
downloadhdf5-d0507c23f30fc1ff66ae4a31d41f681612e51851.zip
hdf5-d0507c23f30fc1ff66ae4a31d41f681612e51851.tar.gz
hdf5-d0507c23f30fc1ff66ae4a31d41f681612e51851.tar.bz2
1.12 Merge A batch of life-cycle examples for different modules #654 (#987)
* Merge A batch of life-cycle examples for different modules #654 * Remove generated file * Change doxygen generated file location
Diffstat (limited to 'src/H5PLmodule.h')
-rw-r--r--src/H5PLmodule.h30
1 files changed, 28 insertions, 2 deletions
diff --git a/src/H5PLmodule.h b/src/H5PLmodule.h
index ab9f1d5..a093096 100644
--- a/src/H5PLmodule.h
+++ b/src/H5PLmodule.h
@@ -28,8 +28,34 @@
#define H5_MY_PKG_INIT YES
/**\defgroup H5PL H5PL
- * \brief Plugins
- * \todo Describe what programmatically controlling dynamically loaded plugins (H5PL) is all about
+ *
+ * Use the functions in this module to manage the loading behavior of HDF5
+ * plugins.
+ *
+ * <table>
+ * <tr><th>Create</th><th>Read</th></tr>
+ * <tr valign="top">
+ * <td>
+ * \snippet H5PL_examples.c create
+ * </td>
+ * <td>
+ * \snippet H5PL_examples.c read
+ * </td>
+ * <tr><th>Update</th><th>Delete</th></tr>
+ * <tr valign="top">
+ * <td>
+ * \snippet H5PL_examples.c update
+ * </td>
+ * <td>
+ * \snippet H5PL_examples.c delete
+ * </td>
+ * </tr>
+ * </table>
+ *
+ * \attention The loading behavior of HDF5 plugins can be controlled via the
+ * functions described below and certain environment variables, such
+ * as \c HDF5_PLUGIN_PRELOAD and \c HDF5_PLUGIN_PATH.
+ *
*/
#endif /* H5PLmodule_H */