[Bf-blender-cvs] [93c19a5a2cf] master: Cleanup: comments (mainly long lines)

Campbell Barton noreply at git.blender.org
Sun Apr 21 06:34:49 CEST 2019


Commit: 93c19a5a2cf58b75aa3072ce79de5e5d571f3d55
Author: Campbell Barton
Date:   Sun Apr 21 13:44:06 2019 +1000
Branches: master
https://developer.blender.org/rB93c19a5a2cf58b75aa3072ce79de5e5d571f3d55

Cleanup: comments (mainly long lines)

Comments after code can cause awkward line breaks.

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

M	source/blender/blenkernel/BKE_mesh.h
M	source/blender/blenkernel/intern/constraint.c
M	source/blender/blenkernel/intern/library_remap.c
M	source/blender/blenkernel/intern/mesh_remap.c
M	source/blender/blenkernel/intern/object_dupli.c
M	source/blender/blenkernel/intern/pbvh.c
M	source/blender/compositor/nodes/COM_DilateErodeNode.h
M	source/blender/draw/engines/eevee/eevee_lightcache.c
M	source/blender/draw/intern/draw_manager.h
M	source/blender/draw/intern/draw_manager_exec.c
M	source/blender/makesrna/intern/rna_internal_types.h
M	source/blender/makesrna/intern/rna_modifier.c
M	source/blender/nodes/intern/node_exec.h
M	source/blender/python/intern/bpy_rna_id_collection.c

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

diff --git a/source/blender/blenkernel/BKE_mesh.h b/source/blender/blenkernel/BKE_mesh.h
index e89e1b05029..d4ad0e771d3 100644
--- a/source/blender/blenkernel/BKE_mesh.h
+++ b/source/blender/blenkernel/BKE_mesh.h
@@ -325,22 +325,25 @@ void BKE_edges_sharp_from_angle_set(const struct MVert *mverts,
  * References a contiguous loop-fan with normal offset vars.
  */
 typedef struct MLoopNorSpace {
-  float vec_lnor[3];  /* Automatically computed loop normal. */
-  float vec_ref[3];   /* Reference vector, orthogonal to vec_lnor. */
-  float vec_ortho[3]; /* Third vector, orthogonal to vec_lnor and vec_ref. */
-  float
-      ref_alpha; /* Reference angle, around vec_ortho, in ]0, pi] range (0.0 marks that space as invalid). */
-  float
-      ref_beta; /* Reference angle, around vec_lnor, in ]0, 2pi] range (0.0 marks that space as invalid). */
-  /* All loops using this lnor space (i.e. smooth fan of loops),
+  /** Automatically computed loop normal. */
+  float vec_lnor[3];
+  /** Reference vector, orthogonal to vec_lnor. */
+  float vec_ref[3];
+  /** Third vector, orthogonal to vec_lnor and vec_ref. */
+  float vec_ortho[3];
+  /** Reference angle, around vec_ortho, in ]0, pi] range (0.0 marks that space as invalid). */
+  float ref_alpha;
+  /** Reference angle, around vec_lnor, in ]0, 2pi] range (0.0 marks that space as invalid). */
+  float ref_beta;
+  /** All loops using this lnor space (i.e. smooth fan of loops),
    * as (depending on owning MLoopNorSpaceArrary.data_type):
    *     - Indices (uint_in_ptr), or
    *     - BMLoop pointers. */
   struct LinkNode *loops;
   char flags;
 
-  void *
-      user_data; /* To be used for extended processing related to loop normal spaces (aka smooth fans). */
+  /** To be used for extended processing related to loop normal spaces (aka smooth fans). */
+  void *user_data;
 } MLoopNorSpace;
 /**
  * MLoopNorSpace.flags
diff --git a/source/blender/blenkernel/intern/constraint.c b/source/blender/blenkernel/intern/constraint.c
index 01dc7c6b3ad..1ceaf8f6821 100644
--- a/source/blender/blenkernel/intern/constraint.c
+++ b/source/blender/blenkernel/intern/constraint.c
@@ -1404,8 +1404,9 @@ static void followpath_evaluate(bConstraint *con, bConstraintOb *cob, ListBase *
     mul_m4_m4m4(cob->matrix, ct->matrix, obmat);
 
     /* un-apply scaling caused by path */
-    if ((data->followflag & FOLLOWPATH_RADIUS) ==
-        0) { /* XXX - assume that scale correction means that radius will have some scale error in it - Campbell */
+    if ((data->followflag & FOLLOWPATH_RADIUS) == 0) {
+      /* XXX: Assume that scale correction means that radius
+       * will have some scale error in it - Campbell. */
       float obsize[3];
 
       mat4_to_size(obsize, cob->matrix);
diff --git a/source/blender/blenkernel/intern/library_remap.c b/source/blender/blenkernel/intern/library_remap.c
index d334804dcd6..5baa7fb3cf8 100644
--- a/source/blender/blenkernel/intern/library_remap.c
+++ b/source/blender/blenkernel/intern/library_remap.c
@@ -145,14 +145,18 @@ typedef struct IDRemap {
   Main *bmain; /* Only used to trigger depsgraph updates in the right bmain. */
   ID *old_id;
   ID *new_id;
-  ID *id; /* The ID in which we are replacing old_id by new_id usages. */
+  /** The ID in which we are replacing old_id by new_id usages. */
+  ID *id;
   short flag;
 
   /* 'Output' data. */
   short status;
-  int skipped_direct; /* Number of direct usecases that could not be remapped (e.g.: obdata when in edit mode). */
-  int skipped_indirect;   /* Number of indirect usecases that could not be remapped. */
-  int skipped_refcounted; /* Number of skipped usecases that refcount the datablock. */
+  /** Number of direct usecases that could not be remapped (e.g.: obdata when in edit mode). */
+  int skipped_direct;
+  /** Number of indirect usecases that could not be remapped. */
+  int skipped_indirect;
+  /** Number of skipped usecases that refcount the datablock. */
+  int skipped_refcounted;
 } IDRemap;
 
 /* IDRemap->flag enums defined in BKE_library.h */
diff --git a/source/blender/blenkernel/intern/mesh_remap.c b/source/blender/blenkernel/intern/mesh_remap.c
index b43339bf73f..6799c6f5c43 100644
--- a/source/blender/blenkernel/intern/mesh_remap.c
+++ b/source/blender/blenkernel/intern/mesh_remap.c
@@ -445,13 +445,16 @@ static int mesh_remap_interp_poly_data_get(const MPoly *mp,
   return sources_num;
 }
 
-/* Little helper when dealing with source islands */
+/** Little helper when dealing with source islands */
 typedef struct IslandResult {
-  float
-      factor; /* A factor, based on which best island for a given set of elements will be selected. */
-  int index_src;      /* Index of the source. */
-  float hit_dist;     /* The actual hit distance. */
-  float hit_point[3]; /* The hit point, if relevant. */
+  /** A factor, based on which best island for a given set of elements will be selected. */
+  float factor;
+  /** Index of the source. */
+  int index_src;
+  /** The actual hit distance. */
+  float hit_dist;
+  /** The hit point, if relevant. */
+  float hit_point[3];
 } IslandResult;
 
 /* Note about all bvh/raycasting stuff below:
diff --git a/source/blender/blenkernel/intern/object_dupli.c b/source/blender/blenkernel/intern/object_dupli.c
index 2544bb6a8f0..9a0e972c46b 100644
--- a/source/blender/blenkernel/intern/object_dupli.c
+++ b/source/blender/blenkernel/intern/object_dupli.c
@@ -66,9 +66,10 @@
 
 typedef struct DupliContext {
   Depsgraph *depsgraph;
-  Collection
-      *collection; /* XXX child objects are selected from this group if set, could be nicer */
-  Object *obedit;  /* Only to check if the object is in edit-mode. */
+  /** XXX child objects are selected from this group if set, could be nicer. */
+  Collection *collection;
+  /** Only to check if the object is in edit-mode. */
+  Object *obedit;
 
   Scene *scene;
   ViewLayer *view_layer;
@@ -80,7 +81,7 @@ typedef struct DupliContext {
 
   const struct DupliGenerator *gen;
 
-  /* result containers */
+  /** Result containers. */
   ListBase *duplilist; /* legacy doubly-linked list */
 } DupliContext;
 
diff --git a/source/blender/blenkernel/intern/pbvh.c b/source/blender/blenkernel/intern/pbvh.c
index 7933f98868a..6529cdb06d7 100644
--- a/source/blender/blenkernel/intern/pbvh.c
+++ b/source/blender/blenkernel/intern/pbvh.c
@@ -505,8 +505,8 @@ static void pbvh_build(PBVH *bvh, BB *cb, BBC *prim_bbc, int totprim)
 /**
  * Do a full rebuild with on Mesh data structure.
  *
- * \note Unlike mpoly/mloop/verts, looptri is **totally owned** by PBVH (which means it may rewrite it if needed,
- * see #BKE_pbvh_apply_vertCos().
+ * \note Unlike mpoly/mloop/verts, looptri is **totally owned** by PBVH
+ * (which means it may rewrite it if needed, see #BKE_pbvh_apply_vertCos().
  */
 void BKE_pbvh_build_mesh(PBVH *bvh,
                          const MPoly *mpoly,
diff --git a/source/blender/compositor/nodes/COM_DilateErodeNode.h b/source/blender/compositor/nodes/COM_DilateErodeNode.h
index 0093d78ca5b..d5b2863a4bb 100644
--- a/source/blender/compositor/nodes/COM_DilateErodeNode.h
+++ b/source/blender/compositor/nodes/COM_DilateErodeNode.h
@@ -26,8 +26,9 @@
  * \ingroup Node
  */
 class DilateErodeNode : public Node {
-  NodeBlurData
-      m_alpha_blur; /* only used for blurring alpha, since the dilate/erode node doesn't have this */
+  /** only used for blurring alpha, since the dilate/erode node doesn't have this. */
+  NodeBlurData m_alpha_blur;
+
  public:
   DilateErodeNode(bNode *editorNode);
   void convertToOperations(NodeConverter &converter, const CompositorContext &context) const;
diff --git a/source/blender/draw/engines/eevee/eevee_lightcache.c b/source/blender/draw/engines/eevee/eevee_lightcache.c
index 9ebd9542ef5..33cb2e87dc7 100644
--- a/source/blender/draw/engines/eevee/eevee_lightcache.c
+++ b/source/blender/draw/engines/eevee/eevee_lightcache.c
@@ -92,38 +92,64 @@ typedef struct EEVEE_LightBake {
   struct Main *bmain;
   EEVEE_ViewLayerData *sldata;
 
-  LightProbe **probe;       /* Current probe being rendered. */
-  GPUTexture *rt_color;     /* Target cube color texture. */
-  GPUTexture *rt_depth;     /* Target cube depth texture. */
-  GPUFrameBuffer *rt_fb[6]; /* Target cube framebuffers. */
-  GPUFrameBuffer *store_fb; /* Storage framebuffer. */
-  int rt_res;               /* Cube render target resolution. */
+  /** Current probe being rendered. */
+  LightProbe **probe;
+  /** Target cube color texture. */
+  GPUTexture *rt_color;
+  /** Target cube depth texture. */
+  GPUTexture *rt_depth;
+  /** Target cube framebuffers. */
+  GPUFrameBuffer *rt_fb[6];
+  /** Storage framebuffer. */
+  GPUFrameBuffer *store_fb;
+  /** Cube render target resolution. */
+  int rt_res;
 
   /* Shared */
-  int layer;                       /* Target layer to store the data to. */
-  float samples_ct, invsamples_ct; /* Sample count for the convolution. */
-  float lod_factor;                /* Sampling bias during convolution step. */
-  float lod_max;                   /* Max cubemap LOD to sample when convolving. */
-  int cube_len, grid_len;          /* Number of probes to render + world probe. */
+  /** Target layer to store the data to. */
+  int layer;
+  /** Sample count for the convolution. */
+  float samples_ct, invsamples_ct;
+  /** Sampling bias during convolution step. */
+  float lod_factor;
+  /** Max cubemap LOD to sample when convolving. */
+  float lod_max;
+  /** Number of probes to render + world probe. */
+  int cube_len, grid_len;
 
   /* Irradiance grid */
-  EEVEE_LightGrid *grid;       /* Current probe being rendered (UBO data). */
-  int irr_cube_res;            /* Target cubemap at MIP 0. */
-  int irr_size[3];             /* Size of the irradiance texture. */
-  int total_irr_samples;       /* Total for all grids */
-  int grid_sample;             /* Nth sample of the current grid being rendered. */
-  int grid_sample_len;         /* Total number of samples for the current grid. */
-  int grid_curr;               /* Nth grid in the cache being rendered. */
-  int bounce_curr, bounce_len; /* The current light bounce being evaluated. */
-  float vis_res;               /* Resolution of the Visibility shadowmap. */
-

@@ Diff output truncated at 10240 characters. @@



More information about the Bf-blender-cvs mailing list