Docs: use doxygen formatting for DNA

Differentiate doc-strings from title/section text.
Also use explicit doxygen references to struct members
so it's not ambiguous which member is being referenced.

Note that these changes aren't complete (some files weren't touched).

1 files changed, 24 insertions, 23 deletions

diff --git a/source/blender/makesdna/DNA_particle_types.h b/source/blender/makesdna/DNA_particle_types.h
index a51c532dfb3..5add664f624 100644
--- a/source/blender/makesdna/DNA_particle_types.h
+++ b/source/blender/makesdna/DNA_particle_types.h
@@ -72,7 +72,7 @@ typedef struct ParticleSpring {
   unsigned int particle_index[2], delete_flag;
 } ParticleSpring;
 
-/* Child particles are created around or between parent particles */
+/** Child particles are created around or between parent particles. */
 typedef struct ChildParticle {
   /** Face index on the final derived mesh. */
   int num;
@@ -364,8 +364,7 @@ typedef struct ParticleSystem {
   int flag, totpart, totunexist, totchild, totcached, totchildcache;
   /* NOTE: Recalc is one of ID_RECALC_PSYS_ALL flags.
    *
-   * TODO(sergey): Use part->id.recalc instead of this duplicated flag
-   * somehow. */
+   * TODO(sergey): Use #ParticleSettings.id.recalc instead of this duplicated flag somehow. */
   int recalc;
   short target_psys, totkeyed, bakespace;
   char _pad1[6];
@@ -438,9 +437,11 @@ typedef enum eParticleDrawFlag {
   PART_DRAW_HAIR_GRID = (1 << 18),
 } eParticleDrawFlag;
 
-/* part->type
+/**
+ * #ParticleSettings.type
  * Hair is always baked static in object/geometry space.
- * Other types (normal particles) are in global space and not static baked. */
+ * Other types (normal particles) are in global space and not static baked.
+ */
 enum {
   PART_EMITTER = 0,
   /* REACTOR type currently unused */
@@ -458,7 +459,7 @@ enum {
   PART_FLUID_SPRAYFOAMBUBBLE = 12,
 };
 
-/* Mirroring Mantaflow particle types from particle.h (Mantaflow header). */
+/** Mirroring Mantaflow particle types from particle.h (Mantaflow header). */
 enum {
   /* PARTICLE_TYPE_NONE = (0 << 0), */ /* UNUSED */
   /* PARTICLE_TYPE_NEW = (1 << 0), */  /* UNUSED */
@@ -470,7 +471,7 @@ enum {
   /* PARTICLE_TYPE_INVALID = (1 << 30), */ /* UNUSED */
 };
 
-/* part->flag */
+/** #ParticleSettings.flag */
 #define PART_REACT_STA_END 1
 #define PART_REACT_MULTIPLE 2
 
@@ -514,26 +515,26 @@ enum {
 
 #define PART_SELF_EFFECT (1 << 22)
 
-/* part->from */
+/** #ParticleSettings.from */
 #define PART_FROM_VERT 0
 #define PART_FROM_FACE 1
 #define PART_FROM_VOLUME 2
 /* #define PART_FROM_PARTICLE   3  deprecated! */
 #define PART_FROM_CHILD 4
 
-/* part->distr */
+/** #ParticleSettings.distr */
 #define PART_DISTR_JIT 0
 #define PART_DISTR_RAND 1
 #define PART_DISTR_GRID 2
 
-/* part->phystype */
+/** #ParticleSettings.phystype */
 #define PART_PHYS_NO 0
 #define PART_PHYS_NEWTON 1
 #define PART_PHYS_KEYED 2
 #define PART_PHYS_BOIDS 3
 #define PART_PHYS_FLUID 4
 
-/* part->kink */
+/** #ParticleSettings.kink */
 typedef enum eParticleKink {
   PART_KINK_NO = 0,
   PART_KINK_CURL = 1,
@@ -543,7 +544,7 @@ typedef enum eParticleKink {
   PART_KINK_SPIRAL = 5,
 } eParticleKink;
 
-/* part->child_flag */
+/** #ParticleSettings.child_flag */
 typedef enum eParticleChildFlag {
   PART_CHILD_USE_CLUMP_NOISE = (1 << 0),
   PART_CHILD_USE_CLUMP_CURVE = (1 << 1),
@@ -551,22 +552,22 @@ typedef enum eParticleChildFlag {
   PART_CHILD_USE_TWIST_CURVE = (1 << 3),
 } eParticleChildFlag;
 
-/* part->shape_flag */
+/** #ParticleSettings.shape_flag */
 typedef enum eParticleShapeFlag {
   PART_SHAPE_CLOSE_TIP = (1 << 0),
 } eParticleShapeFlag;
 
-/* part->draw_col */
+/* #ParticleSettings.draw_col */
 #define PART_DRAW_COL_NONE 0
 #define PART_DRAW_COL_MAT 1
 #define PART_DRAW_COL_VEL 2
 #define PART_DRAW_COL_ACC 3
 
-/* part->time_flag */
+/* #ParticleSettings.time_flag */
 #define PART_TIME_AUTOSF 1 /* Automatic subframes */
 
-/* part->draw_as */
-/* part->ren_as */
+/* #ParticleSettings.draw_as */
+/* #ParticleSettings.ren_as */
 #define PART_DRAW_NOT 0
 #define PART_DRAW_DOT 1
 #define PART_DRAW_HALO 1
@@ -580,13 +581,13 @@ typedef enum eParticleShapeFlag {
 #define PART_DRAW_BB 9 /* deprecated */
 #define PART_DRAW_REND 10
 
-/* part->integrator */
+/* #ParticleSettings.integrator */
 #define PART_INT_EULER 0
 #define PART_INT_MIDPOINT 1
 #define PART_INT_RK4 2
 #define PART_INT_VERLET 3
 
-/* part->rotmode */
+/* #ParticleSettings.rotmode */
 #define PART_ROT_NOR 1
 #define PART_ROT_VEL 2
 #define PART_ROT_GLOB_X 3
@@ -597,7 +598,7 @@ typedef enum eParticleShapeFlag {
 #define PART_ROT_OB_Z 8
 #define PART_ROT_NOR_TAN 9
 
-/* part->avemode */
+/* #ParticleSettings.avemode */
 #define PART_AVE_VELOCITY 1
 #define PART_AVE_RAND 2
 #define PART_AVE_HORIZONTAL 3
@@ -606,12 +607,12 @@ typedef enum eParticleShapeFlag {
 #define PART_AVE_GLOBAL_Y 6
 #define PART_AVE_GLOBAL_Z 7
 
-/* part->reactevent */
+/* #ParticleSettings.reactevent */
 #define PART_EVENT_DEATH 0
 #define PART_EVENT_COLLIDE 1
 #define PART_EVENT_NEAR 2
 
-/* part->childtype */
+/* #ParticleSettings.childtype */
 #define PART_CHILD_PARTICLES 1
 #define PART_CHILD_FACES 2
 
@@ -675,7 +676,7 @@ typedef enum eParticleShapeFlag {
 #define PTARGET_MODE_FRIEND 1
 #define PTARGET_MODE_ENEMY 2
 
-/* mapto */
+/** #MTex.mapto */
 typedef enum eParticleTextureInfluence {
   /* init */
   PAMAP_TIME = (1 << 0), /* emission time */