summaryrefslogtreecommitdiffstats
path: root/src/H5Smodule.h
diff options
context:
space:
mode:
authorbljhdf <58825073+bljhdf@users.noreply.github.com>2020-11-23 22:17:44 (GMT)
committerGitHub <noreply@github.com>2020-11-23 22:17:44 (GMT)
commitc56464fc36a78167c22b84e4cfef0e0c2aafce80 (patch)
treee10abc0a4c439f6723295a3aa7227e3d54b4552c /src/H5Smodule.h
parentecbcb4356c2bbdad7ad801f9c61fe695082a6b25 (diff)
downloadhdf5-c56464fc36a78167c22b84e4cfef0e0c2aafce80.zip
hdf5-c56464fc36a78167c22b84e4cfef0e0c2aafce80.tar.gz
hdf5-c56464fc36a78167c22b84e4cfef0e0c2aafce80.tar.bz2
Doxygen - added (mostly) beginner functions (#112)
* Doxygen - added (mostly) beginner functions * Removed duplicate H5Pset_szip function
Diffstat (limited to 'src/H5Smodule.h')
-rw-r--r--src/H5Smodule.h27
1 files changed, 27 insertions, 0 deletions
diff --git a/src/H5Smodule.h b/src/H5Smodule.h
index 11494ee..6e8208b 100644
--- a/src/H5Smodule.h
+++ b/src/H5Smodule.h
@@ -29,4 +29,31 @@
#define H5_MY_PKG_ERR H5E_DATASPACE
#define H5_MY_PKG_INIT YES
+/**\defgroup H5S H5S
+ * \brief Dataspace Interface
+ *
+ * \details The Dataspace Interface provides functions for creating and
+ * working with dataspaces.
+ *
+ * A dataspace has two roles:
+ *
+ * \li It contains the spatial information (logical layout) of a
+ * dataset stored in a file.
+ * \li It describes an application’s data buffers and data elements
+ * participating in I/O. In other words, it can be used to
+ * select a portion or subset of a dataset.
+ *
+ * The spatial information of a dataset in a file includes the
+ * rank and dimensions of the dataset, which are a permanent part
+ * of the dataset definition. It can have dimensions that are fixed
+ * (unchanging) or unlimited, which means they can grow in size
+ * (or are extendible).
+ *
+ * A dataspace can consist of:
+ * \li no elements (NULL)
+ * \li a single element (scalar), or
+ * \li a simple array.
+ *
+ */
+
#endif /* _H5Smodule_H */