[Bf-blender-cvs] [1896c2c0e8b] master: Docs: comment values for DispList.type

[Campbell Barton]

Commit: 1896c2c0e8bf5386b52e6f1b4d29fada284710af
Author: Campbell Barton
Date:   Tue Sep 8 17:15:09 2020 +1000
Branches: master
https://developer.blender.org/rB1896c2c0e8bf5386b52e6f1b4d29fada284710af

Docs: comment values for DispList.type

===================================================================

M	source/blender/blenkernel/BKE_displist.h

===================================================================

diff --git a/source/blender/blenkernel/BKE_displist.h b/source/blender/blenkernel/BKE_displist.h
index 7e1a6e54ede..b2502031029 100644
--- a/source/blender/blenkernel/BKE_displist.h
+++ b/source/blender/blenkernel/BKE_displist.h
@@ -30,16 +30,24 @@
 extern "C" {
 #endif
 
-/* dl->type */
-#define DL_POLY 0
-#define DL_SEGM 1
-#define DL_SURF 2
-#define DL_INDEX3 4
-#define DL_INDEX4 5
-// #define DL_VERTCOL              6  // UNUSED
-#define DL_VERTS 7
-
-/* dl->flag */
+/** #DispList.type */
+enum {
+  /** A closed polygon (that can be filled).  */
+  DL_POLY = 0,
+  /** An open polygon.  */
+  DL_SEGM = 1,
+  /** A grid surface that respects #DL_CYCL_U & #DL_CYCL_V.  */
+  DL_SURF = 2,
+  /** Triangles. */
+  DL_INDEX3 = 4,
+  /** Quads, with support for triangles (when values of the 3rd and 4th indices match). */
+  DL_INDEX4 = 5,
+  // DL_VERTCOL = 6, /* UNUSED */
+  /** Isolated points. */
+  DL_VERTS = 7,
+};
+
+/** #DispList.type */
 enum {
   /** U/V swapped here compared with #Nurb.flagu, #Nurb.flagv and #CU_NURB_CYCLIC */
   DL_CYCL_U = (1 << 0),