p4est_connectivity: document P4EST_CONNECT enum

cburstedde · Oct 27, 2023 · a27287f · a27287f
1 parent 3c98b0f
commit a27287f
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 9 deletions.
diff --git a/src/p4est_connectivity.h b/src/p4est_connectivity.h
@@ -112,10 +112,10 @@ SC_EXTERN_C_BEGIN;
 typedef enum
 {
   /* make sure to have different values 2D and 3D */
-  P4EST_CONNECT_SELF = 20,
-  P4EST_CONNECT_FACE = 21,
-  P4EST_CONNECT_CORNER = 22,
-  P4EST_CONNECT_FULL = P4EST_CONNECT_CORNER
+  P4EST_CONNECT_SELF = 20,      /**< no connection across trees */
+  P4EST_CONNECT_FACE = 21,      /**< connection across tree faces only */
+  P4EST_CONNECT_CORNER = 22,    /**< connection across tree faces and corners */
+  P4EST_CONNECT_FULL = P4EST_CONNECT_CORNER     /**< Shortcut for full connection */
 }
 p4est_connect_type_t;
 

diff --git a/src/p8est_connectivity.h b/src/p8est_connectivity.h
@@ -89,11 +89,11 @@ SC_EXTERN_C_BEGIN;
 typedef enum
 {
   /* make sure to have different values 2D and 3D */
-  P8EST_CONNECT_SELF = 30,
-  P8EST_CONNECT_FACE = 31,
-  P8EST_CONNECT_EDGE = 32,
-  P8EST_CONNECT_CORNER = 33,
-  P8EST_CONNECT_FULL = P8EST_CONNECT_CORNER
+  P8EST_CONNECT_SELF = 30,      /**< no connection across trees */
+  P8EST_CONNECT_FACE = 31,      /**< connection across tree faces only */
+  P8EST_CONNECT_EDGE = 32,      /**< connection across tree faces and edges */
+  P8EST_CONNECT_CORNER = 33,    /**< connection across all codimensions */
+  P8EST_CONNECT_FULL = P8EST_CONNECT_CORNER     /**< shortcut for full connectivity */
 }
 p8est_connect_type_t;