[Bf-blender-cvs] [3bf8074d831] ui-asset-view-template: Cleanup: spelling, minor corrections
Campbell Barton
noreply at git.blender.org
Wed Mar 3 21:45:18 CET 2021
Commit: 3bf8074d8318f3f2e4af2cb4dde576b69af5da79
Author: Campbell Barton
Date: Wed Mar 3 06:14:01 2021 +1100
Branches: ui-asset-view-template
https://developer.blender.org/rB3bf8074d8318f3f2e4af2cb4dde576b69af5da79
Cleanup: spelling, minor corrections
Also use doxygen comments for sculpt functions.
===================================================================
M intern/ghost/intern/GHOST_SystemCocoa.mm
M source/blender/bmesh/intern/bmesh_marking.c
M source/blender/draw/intern/draw_manager.h
M source/blender/editors/armature/armature_relations.c
M source/blender/editors/sculpt_paint/sculpt_expand.c
M source/blender/editors/uvedit/uvedit_select.c
M source/blender/makesdna/DNA_windowmanager_types.h
M source/blender/sequencer/intern/sequencer.c
===================================================================
diff --git a/intern/ghost/intern/GHOST_SystemCocoa.mm b/intern/ghost/intern/GHOST_SystemCocoa.mm
index f42d4af109a..3b20c95c954 100644
--- a/intern/ghost/intern/GHOST_SystemCocoa.mm
+++ b/intern/ghost/intern/GHOST_SystemCocoa.mm
@@ -80,7 +80,7 @@ static GHOST_TButtonMask convertButton(int button)
}
/**
- * Converts Mac rawkey codes (same for Cocoa & Carbon)
+ * Converts Mac raw-key codes (same for Cocoa & Carbon)
* into GHOST key codes
* \param rawCode: The raw physical key code
* \param recvChar: the character ignoring modifiers (except for shift)
diff --git a/source/blender/bmesh/intern/bmesh_marking.c b/source/blender/bmesh/intern/bmesh_marking.c
index 9cd1a2fd4ec..d479a555a58 100644
--- a/source/blender/bmesh/intern/bmesh_marking.c
+++ b/source/blender/bmesh/intern/bmesh_marking.c
@@ -46,7 +46,7 @@ static void recount_totsels(BMesh *bm)
int *tots[3];
int i;
- /* recount (tot * sel) variables */
+ /* Recount total selection variables. */
bm->totvertsel = bm->totedgesel = bm->totfacesel = 0;
tots[0] = &bm->totvertsel;
tots[1] = &bm->totedgesel;
diff --git a/source/blender/draw/intern/draw_manager.h b/source/blender/draw/intern/draw_manager.h
index f540ff09032..84bc0327aa2 100644
--- a/source/blender/draw/intern/draw_manager.h
+++ b/source/blender/draw/intern/draw_manager.h
@@ -46,10 +46,10 @@
struct DupliObject;
struct Object;
-/* Use draw manager to call GPU_select, see: DRW_draw_select_loop */
+/** Use draw manager to call GPU_select, see: #DRW_draw_select_loop */
#define USE_GPU_SELECT
-/* Use drawcall batching using instanced rendering. */
+/** Use draw-call batching using instanced rendering. */
#define USE_BATCHING 1
// #define DRW_DEBUG_CULLING
diff --git a/source/blender/editors/armature/armature_relations.c b/source/blender/editors/armature/armature_relations.c
index bb5bcd4083e..4dbe448c4ec 100644
--- a/source/blender/editors/armature/armature_relations.c
+++ b/source/blender/editors/armature/armature_relations.c
@@ -552,9 +552,12 @@ static void separated_armature_fix_links(Main *bmain, Object *origArm, Object *n
}
}
-/* Helper function for armature separating - remove certain bones from the given armature
- * sel: remove selected bones from the armature, otherwise the unselected bones are removed
- * (ob is not in edit-mode)
+/**
+ * Helper function for armature separating - remove certain bones from the given armature.
+ *
+ * \param ob: Armature object (must not be is not in edit-mode).
+ * \param is_select: remove selected bones from the armature,
+ * otherwise the unselected bones are removed.
*/
static void separate_armature_bones(Main *bmain, Object *ob, const bool is_select)
{
diff --git a/source/blender/editors/sculpt_paint/sculpt_expand.c b/source/blender/editors/sculpt_paint/sculpt_expand.c
index aaa4bed0d2e..53f2821eb76 100644
--- a/source/blender/editors/sculpt_paint/sculpt_expand.c
+++ b/source/blender/editors/sculpt_paint/sculpt_expand.c
@@ -86,37 +86,44 @@
* are only valid on parts of the mesh that are in the same connected component as the given
* initial vertices. If needed, these falloff values are propagated from vertex or grids into the
* base mesh faces.
+ *
* - On each modal callback, the operator gets the active vertex and face and gets its falloff
- * value from its precalculated falloff. This is now the active falloff value.
+ * value from its precalculated falloff. This is now the active falloff value.
* - Using the active falloff value and the settings of the expand operation (which can be modified
- * during execution using the modal keymap), the operator loops over all elements in the mesh to
- * check if they are enabled of not.
+ * during execution using the modal key-map), the operator loops over all elements in the mesh to
+ * check if they are enabled of not.
* - Based on each element state after evaluating the settings, the desired mesh data (mask, face
- * sets, colors...) is updated.
+ * sets, colors...) is updated.
*/
-/* Used for defining an invalid vertex state (for example, when the cursor is not over the mesh).
+/**
+ * Used for defining an invalid vertex state (for example, when the cursor is not over the mesh).
*/
#define SCULPT_EXPAND_VERTEX_NONE -1
-/* Used for defining an uninitialized active component index for an unused symmetry pass. */
-
+/** Used for defining an uninitialized active component index for an unused symmetry pass. */
#define EXPAND_ACTIVE_COMPONENT_NONE -1
-/* Defines how much each time the texture distortion is increased/decreased when using the modal
- * keymap. */
+/**
+ * Defines how much each time the texture distortion is increased/decreased
+ * when using the modal key-map.
+ */
#define SCULPT_EXPAND_TEXTURE_DISTORTION_STEP 0.01f
-/* This threshold offsets the required falloff value to start a new loop. This is needed because in
+/**
+ * This threshold offsets the required falloff value to start a new loop. This is needed because in
* some situations, vertices which have the same falloff value as max_falloff will start a new
- * loop, which is undesired. */
+ * loop, which is undesired.
+ */
#define SCULPT_EXPAND_LOOP_THRESHOLD 0.00001f
-/* Defines how much changes in curvature in the mesh affect the falloff shape when using normal
+/**
+ * Defines how much changes in curvature in the mesh affect the falloff shape when using normal
* falloff. This default was found experimentally and it works well in most cases, but can be
- * exposed for tweaking if needed. */
+ * exposed for tweaking if needed.
+ */
#define SCULPT_EXPAND_NORMALS_FALLOFF_EDGE_SENSITIVITY 300
-/* Expand Modal Keymap. */
+/* Expand Modal Key-map. */
enum {
SCULPT_EXPAND_MODAL_CONFIRM = 1,
SCULPT_EXPAND_MODAL_CANCEL,
@@ -143,8 +150,10 @@ enum {
* functions for getting the state of an element return true it means that data associated to that
* element will be modified by expand. */
-/* Returns true if the vertex is in a connected component with correctly initialized falloff
- * values. */
+/**
+ * Returns true if the vertex is in a connected component with correctly initialized falloff
+ * values.
+ */
static bool sculpt_expand_is_vert_in_active_component(SculptSession *ss,
ExpandCache *expand_cache,
const int v)
@@ -157,7 +166,8 @@ static bool sculpt_expand_is_vert_in_active_component(SculptSession *ss,
return false;
}
-/* Returns true if the face is in a connected component with correctly initialized falloff values.
+/**
+ * Returns true if the face is in a connected component with correctly initialized falloff values.
*/
static bool sculpt_expand_is_face_in_active_component(SculptSession *ss,
ExpandCache *expand_cache,
@@ -167,8 +177,10 @@ static bool sculpt_expand_is_face_in_active_component(SculptSession *ss,
return sculpt_expand_is_vert_in_active_component(ss, expand_cache, loop->v);
}
-/* Returns the falloff value of a vertex. This function includes texture distortion, which is not
- * precomputed into the initial falloff values. */
+/**
+ * Returns the falloff value of a vertex. This function includes texture distortion, which is not
+ * precomputed into the initial falloff values.
+ */
static float sculpt_expand_falloff_value_vertex_get(SculptSession *ss,
ExpandCache *expand_cache,
const int v)
@@ -191,8 +203,10 @@ static float sculpt_expand_falloff_value_vertex_get(SculptSession *ss,
return expand_cache->vert_falloff[v] + distortion;
}
-/* Returns the maximum valid falloff value stored in the falloff array, taking the maximum possible
- * texture distortion into account. */
+/**
+ * Returns the maximum valid falloff value stored in the falloff array, taking the maximum possible
+ * texture distortion into account.
+ */
static float sculpt_expand_max_vertex_falloff_get(ExpandCache *expand_cache)
{
if (expand_cache->texture_distortion_strength == 0.0f) {
@@ -207,8 +221,9 @@ static float sculpt_expand_max_vertex_falloff_get(ExpandCache *expand_cache)
(0.5f * expand_cache->texture_distortion_strength * expand_cache->max_vert_falloff);
}
-/* Main function to get the state of a vertex for the current state and settings of a ExpandCache.
- * Retruns true when the target data should be modified by expand.
+/**
+ * Main function to get the state of a vertex for the current state and settings of a #ExpandCache.
+ * Returns true when the target data should be modified by expand.
*/
static bool sculpt_expand_state_get(SculptSession *ss, ExpandCache *expand_cache, const int v)
{
@@ -252,8 +267,10 @@ static bool sculpt_expand_state_get(SculptSession *ss, ExpandCache *expand_cache
return enabled;
}
-/* Main function to get the state of a face for the current state and settings of a ExpandCache.
- * Returs true when the traget data should be modified by expand. */
+/**
+ * Main function to get the state of a face for the current state and settings of a #ExpandCache.
+ * Returns true when the target data should be modified by expand.
+ */
static bool sculpt_expand_face_state_get(SculptSession *ss, ExpandCache *expand_cache, const int f)
{
if (ss->face_sets[f] <= 0) {
@@ -296,8 +313,10 @@ static bool sculpt_expand_face_state_get(SculptSession *ss, ExpandCache *expand_
return enabled;
}
-/* For target modes that support gradients (such as sculpt masks or colors), this function returns
- * the corresponding gradient value for an enabled vertex. */
+/**
+ * For target modes that support gradients (such as sculpt masks or colors), this function returns
+ * the corresponding gradient value for an enabled vertex.
+ */
static float sculpt_expand_gradient_value_get(SculptSession *ss,
ExpandCache *expand_cache,
const int v)
@@ -335,8 +354,10 @@ static float sculpt_expand_gradient_value_get(SculptSession *ss,
/* Utility functions for getting all vertices state during expand. */
-/* Retu
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list