summaryrefslogtreecommitdiffstats
path: root/src/H5module.h
diff options
context:
space:
mode:
authorGerd Heber <gheber@hdfgroup.org>2020-11-18 15:06:01 (GMT)
committerGitHub <noreply@github.com>2020-11-18 15:06:01 (GMT)
commit0a06b9a8690f6c968c036142fd1b1a83cbcd7617 (patch)
tree73e4b095ef9b1ea5f3ec9ad1a450bc193f8c75f8 /src/H5module.h
parenta50d211755cb272b2e468144e7d892a4c90813c4 (diff)
downloadhdf5-0a06b9a8690f6c968c036142fd1b1a83cbcd7617.zip
hdf5-0a06b9a8690f6c968c036142fd1b1a83cbcd7617.tar.gz
hdf5-0a06b9a8690f6c968c036142fd1b1a83cbcd7617.tar.bz2
First cut of the H5 public API documentation. (#80)
* First cut of the H5 public API documentation. * Added H5Z "bonus track." * Applied Quincey's patch. * Added the missing patches from Quincey's original patch. * H5PL (complete) and basic H5VL API documentation. * Added H5I API docs. * Added H5L API docs. * First installment from Elena's H5T batch. * Second installment of Elena's H5T batch. * Final installment of Elena's H5T batch.
Diffstat (limited to 'src/H5module.h')
-rw-r--r--src/H5module.h34
1 files changed, 34 insertions, 0 deletions
diff --git a/src/H5module.h b/src/H5module.h
new file mode 100644
index 0000000..f6884b1
--- /dev/null
+++ b/src/H5module.h
@@ -0,0 +1,34 @@
+/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
+ * Copyright by The HDF Group. *
+ * All rights reserved. *
+ * *
+ * This file is part of HDF5. The full HDF5 copyright notice, including *
+ * terms governing use, modification, and redistribution, is contained in *
+ * the COPYING file, which can be found at the root of the source code *
+ * distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases. *
+ * If you do not have access to either file, you may request a copy from *
+ * help@hdfgroup.org. *
+ * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
+
+/*
+ * Purpose: This file contains declarations which define macros for the
+ * H5 package. Including this header means that the source file
+ * is part of the H5 package.
+ */
+#ifndef _H5module_H
+#define _H5module_H
+
+/* Define the proper control macros for the generic FUNC_ENTER/LEAVE and error
+ * reporting macros.
+ */
+#define H5_MODULE
+#define H5_MY_PKG H5
+#define H5_MY_PKG_ERR H5E_LIB
+#define H5_MY_PKG_INIT YES
+
+/**\defgroup H5 H5
+ * \brief General Library Functions
+ * \todo Describe concisely what the functions in this module are about.
+ */
+
+#endif /* _H5module_H */