Merge branch 'develop' of https://bitbucket.hdfgroup.org/scm/hdffv/hdf5 into merge_hyperslab_updates

1 files changed, 47 insertions, 36 deletions

diff --git a/src/H5Rpublic.h b/src/H5Rpublic.h
index e990661..598bafd 100644
--- a/src/H5Rpublic.h
+++ b/src/H5Rpublic.h
@@ -5,12 +5,10 @@
  *                                                                           *
  * This file is part of HDF5.  The full HDF5 copyright notice, including     *
  * terms governing use, modification, and redistribution, is contained in    *
- * the files COPYING and Copyright.html.  COPYING can be found at the root   *
- * of the source code distribution tree; Copyright.html can be found at the  *
- * root level of an installed copy of the electronic HDF5 document set and   *
- * is linked from the top-level documents page.  It can also be found at     *
- * http://hdfgroup.org/HDF5/doc/Copyright.html.  If you do not have          *
- * access to either file, you may request a copy from help@hdfgroup.org.     *
+ * 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.                                                        *
  * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
 
 /*
@@ -24,40 +22,59 @@
 #include "H5Gpublic.h"
 #include "H5Ipublic.h"
 
-/*
- * Reference types allowed.
- */
-typedef enum {
-    H5R_BADTYPE     =   (-1),   /*invalid Reference Type                     */
-    H5R_OBJECT,                 /*Object reference                           */
-    H5R_DATASET_REGION,         /*Dataset Region Reference                   */
-    H5R_MAXTYPE                 /*highest type (Invalid as true type)	     */
-} H5R_type_t;
+/*****************/
+/* Public Macros */
+/*****************/
 
 /* Note! Be careful with the sizes of the references because they should really
  * depend on the run-time values in the file.  Unfortunately, the arrays need
- * to be defined at compile-time, so we have to go with the worst case sizes for
- * them.  -QAK
+ * to be defined at compile-time, so we have to go with the worst case sizes
+ * for them.  -QAK
+ */
+#define H5R_OBJ_REF_BUF_SIZE        sizeof(haddr_t)
+
+/* 4 is used instead of sizeof(int) to permit portability between the Crays
+ * and other machines (the heap ID is always encoded as an int32 anyway).
+ */
+#define H5R_DSET_REG_REF_BUF_SIZE   (sizeof(haddr_t) + 4)
+
+/*******************/
+/* Public Typedefs */
+/*******************/
+
+/* Reference types */
+typedef enum H5R_type_t {
+    H5R_BADTYPE     =   (-1),   /* Invalid Reference Type               */
+    H5R_OBJECT,                 /* Object reference                     */
+    H5R_DATASET_REGION,         /* Dataset Region Reference             */
+    H5R_MAXTYPE                 /* Highest type (Invalid as true type)  */
+} H5R_type_t;
+
+/* Object reference structure for user's code
+ * This needs to be large enough to store largest haddr_t on a worst case
+ * machine (8 bytes currently).
+ */
+typedef haddr_t hobj_ref_t;
+
+/* Dataset Region reference structure for user's code
+ * (Buffer to store heap ID and index)
+ * This needs to be large enough to store largest haddr_t in a worst case
+ * machine (8 bytes currently) plus an int
  */
-#define H5R_OBJ_REF_BUF_SIZE    sizeof(haddr_t)
-/* Object reference structure for user's code */
-typedef haddr_t hobj_ref_t; /* Needs to be large enough to store largest haddr_t in a worst case machine (ie. 8 bytes currently) */
+typedef unsigned char hdset_reg_ref_t[H5R_DSET_REG_REF_BUF_SIZE];
 
-#define H5R_DSET_REG_REF_BUF_SIZE    (sizeof(haddr_t)+4)
-/* 4 is used instead of sizeof(int) to permit portability between
-   the Crays and other machines (the heap ID is always encoded as an int32 anyway)
-*/
-/* Dataset Region reference structure for user's code */
-typedef unsigned char hdset_reg_ref_t[H5R_DSET_REG_REF_BUF_SIZE];/* Buffer to store heap ID and index */
-/* Needs to be large enough to store largest haddr_t in a worst case machine (ie. 8 bytes currently) plus an int */
+/********************/
+/* Public Variables */
+/********************/
 
-/* Publicly visible data structures */
+/*********************/
+/* Public Prototypes */
+/*********************/
 
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-/* Functions in H5R.c */
 H5_DLL herr_t H5Rcreate(void *ref, hid_t loc_id, const char *name,
 			 H5R_type_t ref_type, hid_t space_id);
 H5_DLL hid_t H5Rdereference2(hid_t obj_id, hid_t oapl_id, H5R_type_t ref_type, const void *ref);
@@ -65,7 +82,7 @@ H5_DLL hid_t H5Rget_region(hid_t dataset, H5R_type_t ref_type, const void *ref);
 H5_DLL herr_t H5Rget_obj_type2(hid_t id, H5R_type_t ref_type, const void *_ref,
     H5O_type_t *obj_type);
 H5_DLL ssize_t H5Rget_name(hid_t loc_id, H5R_type_t ref_type, const void *ref,
-    char *name/*out*/, size_t size);
+    char *name /*out*/, size_t size);
 
 /* Symbols defined for compatibility with previous versions of the HDF5 API.
  *
@@ -73,12 +90,6 @@ H5_DLL ssize_t H5Rget_name(hid_t loc_id, H5R_type_t ref_type, const void *ref,
  */
 #ifndef H5_NO_DEPRECATED_SYMBOLS
 
-/* Macros */
-
-
-/* Typedefs */
-
-
 /* Function prototypes */
 H5_DLL H5G_obj_t H5Rget_obj_type1(hid_t id, H5R_type_t ref_type, const void *_ref);
 H5_DLL hid_t H5Rdereference1(hid_t obj_id, H5R_type_t ref_type, const void *ref);