Add documentation (H5P)

HDFGroup · Mar 27, 2024 · 894b1b3 · 894b1b3
1 parent ce3784d
commit 894b1b3
Showing 1 changed file with 129 additions and 3 deletions.
diff --git a/src/H5Ppublic.h b/src/H5Ppublic.h
@@ -46,56 +46,182 @@
  * The library's property list classes
  */
 
+/**
+ * Property list class root, is not user-accessible
+ */
 #define H5P_ROOT             (H5OPEN H5P_CLS_ROOT_ID_g)
+/**
+ * Object creation property list class, is not user-accessible
+ */
 #define H5P_OBJECT_CREATE    (H5OPEN H5P_CLS_OBJECT_CREATE_ID_g)
+/**
+ * File creation property list class
+ */
 #define H5P_FILE_CREATE      (H5OPEN H5P_CLS_FILE_CREATE_ID_g)
+/**
+ * File access property list class
+ */
 #define H5P_FILE_ACCESS      (H5OPEN H5P_CLS_FILE_ACCESS_ID_g)
+/**
+ * Dataset creation property list class
+ */
 #define H5P_DATASET_CREATE   (H5OPEN H5P_CLS_DATASET_CREATE_ID_g)
+/**
+ * Dataset access property list class
+ */
 #define H5P_DATASET_ACCESS   (H5OPEN H5P_CLS_DATASET_ACCESS_ID_g)
+/**
+ * Dataset transfer property list class
+ */
 #define H5P_DATASET_XFER     (H5OPEN H5P_CLS_DATASET_XFER_ID_g)
+/**
+ * File mount property list class
+ */
 #define H5P_FILE_MOUNT       (H5OPEN H5P_CLS_FILE_MOUNT_ID_g)
+/**
+ * Group creation property list class
+ */
 #define H5P_GROUP_CREATE     (H5OPEN H5P_CLS_GROUP_CREATE_ID_g)
+/**
+ * Group access property list class
+ */
 #define H5P_GROUP_ACCESS     (H5OPEN H5P_CLS_GROUP_ACCESS_ID_g)
+/**
+ * Datatype creation property list class
+ */
 #define H5P_DATATYPE_CREATE  (H5OPEN H5P_CLS_DATATYPE_CREATE_ID_g)
+/**
+ * Datatype access property list class
+ */
 #define H5P_DATATYPE_ACCESS  (H5OPEN H5P_CLS_DATATYPE_ACCESS_ID_g)
+/**
+ * Map creation property list class
+ */
 #define H5P_MAP_CREATE       (H5OPEN H5P_CLS_MAP_CREATE_ID_g)
+/**
+ * Map access property list class
+ */
 #define H5P_MAP_ACCESS       (H5OPEN H5P_CLS_MAP_ACCESS_ID_g)
+/**
+ * String creation property list class, is not user-accessible
+ */
 #define H5P_STRING_CREATE    (H5OPEN H5P_CLS_STRING_CREATE_ID_g)
+/**
+ * Attribute creation property list class
+ */
 #define H5P_ATTRIBUTE_CREATE (H5OPEN H5P_CLS_ATTRIBUTE_CREATE_ID_g)
+/**
+ * Attribute access property list class
+ */
 #define H5P_ATTRIBUTE_ACCESS (H5OPEN H5P_CLS_ATTRIBUTE_ACCESS_ID_g)
+/**
+ * Object copy property list class
+ */
 #define H5P_OBJECT_COPY      (H5OPEN H5P_CLS_OBJECT_COPY_ID_g)
+/**
+ * Link creation property list class
+ */
 #define H5P_LINK_CREATE      (H5OPEN H5P_CLS_LINK_CREATE_ID_g)
+/**
+ * Link access property list class
+ */
 #define H5P_LINK_ACCESS      (H5OPEN H5P_CLS_LINK_ACCESS_ID_g)
+/**
+ * VOL initialization property list class
+ */
 #define H5P_VOL_INITIALIZE   (H5OPEN H5P_CLS_VOL_INITIALIZE_ID_g)
+/**
+ * Reference access property list class
+ */
 #define H5P_REFERENCE_ACCESS (H5OPEN H5P_CLS_REFERENCE_ACCESS_ID_g)
 
 /*
  * The library's default property lists
  */
+/**
+ * File creation default property list
+ */
 #define H5P_FILE_CREATE_DEFAULT      (H5OPEN H5P_LST_FILE_CREATE_ID_g)
+/**
+ * File access default property list
+ */
 #define H5P_FILE_ACCESS_DEFAULT      (H5OPEN H5P_LST_FILE_ACCESS_ID_g)
+/**
+ * Dataset creation default property list
+ */
 #define H5P_DATASET_CREATE_DEFAULT   (H5OPEN H5P_LST_DATASET_CREATE_ID_g)
+/**
+ * Dataset access default property list
+ */
 #define H5P_DATASET_ACCESS_DEFAULT   (H5OPEN H5P_LST_DATASET_ACCESS_ID_g)
+/**
+ * Dataset transfer default property list
+ */
 #define H5P_DATASET_XFER_DEFAULT     (H5OPEN H5P_LST_DATASET_XFER_ID_g)
+/**
+ * File mount default property list
+ */
 #define H5P_FILE_MOUNT_DEFAULT       (H5OPEN H5P_LST_FILE_MOUNT_ID_g)
+/**
+ * Group creation default property list
+ */
 #define H5P_GROUP_CREATE_DEFAULT     (H5OPEN H5P_LST_GROUP_CREATE_ID_g)
+/**
+ * Group access default property list
+ */
 #define H5P_GROUP_ACCESS_DEFAULT     (H5OPEN H5P_LST_GROUP_ACCESS_ID_g)
+/**
+ * Datytype creation default property list
+ */
 #define H5P_DATATYPE_CREATE_DEFAULT  (H5OPEN H5P_LST_DATATYPE_CREATE_ID_g)
+/**
+ * Datytype access default property list
+ */
 #define H5P_DATATYPE_ACCESS_DEFAULT  (H5OPEN H5P_LST_DATATYPE_ACCESS_ID_g)
+/**
+ * Map creation default property list
+ */
 #define H5P_MAP_CREATE_DEFAULT       (H5OPEN H5P_LST_MAP_CREATE_ID_g)
+/**
+ * Map access default property list
+ */
 #define H5P_MAP_ACCESS_DEFAULT       (H5OPEN H5P_LST_MAP_ACCESS_ID_g)
+/**
+ * Attribute creation default property list
+ */
 #define H5P_ATTRIBUTE_CREATE_DEFAULT (H5OPEN H5P_LST_ATTRIBUTE_CREATE_ID_g)
+/**
+ * Attribute access default property list
+ */
 #define H5P_ATTRIBUTE_ACCESS_DEFAULT (H5OPEN H5P_LST_ATTRIBUTE_ACCESS_ID_g)
+/**
+ * Object copy default property list
+ */
 #define H5P_OBJECT_COPY_DEFAULT      (H5OPEN H5P_LST_OBJECT_COPY_ID_g)
+/**
+ * Link creation default property list
+ */
 #define H5P_LINK_CREATE_DEFAULT      (H5OPEN H5P_LST_LINK_CREATE_ID_g)
+/**
+ * Link access default property list
+ */
 #define H5P_LINK_ACCESS_DEFAULT      (H5OPEN H5P_LST_LINK_ACCESS_ID_g)
+/**
+ * VOL initialization default property list
+ */
 #define H5P_VOL_INITIALIZE_DEFAULT   (H5OPEN H5P_LST_VOL_INITIALIZE_ID_g)
+/**
+ * Reference access default property list
+ */
 #define H5P_REFERENCE_ACCESS_DEFAULT (H5OPEN H5P_LST_REFERENCE_ACCESS_ID_g)
-
-/* Common creation order flags (for links in groups and attributes on objects) */
+/**
+ * Attribute creation order is tracked but not necessarily indexed
+ */
 #define H5P_CRT_ORDER_TRACKED 0x0001
+/**
+ * Attribute creation order is indexed (requires #H5P_CRT_ORDER_TRACKED)
+ */
 #define H5P_CRT_ORDER_INDEXED 0x0002
-
 /**
  * Default value of type \ref hid_t for all property list classes
  */