tmaq
/
tornavis
1
0
Fork 0
Code Issues 2 Pull Requests 29 Packages Projects 24 Releases Wiki Activity

Cleanup: spelling in comments, use doxygen doc-strings

This commit is contained in:
Campbell Barton 2023-11-02 16:42:45 +11:00
parent 19254ae44c
commit 6983c14955
10 changed files with 39 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
source/blender/animrig/intern/keyframing_auto.cc
View File

@ -339,4 +339,4 @@ bool autokeyframe_property(bContext *C,
return changed;
}
} // namespace blender::animrig
} // namespace blender::animrig

2
source/blender/animrig/intern/visualkey.cc
View File

@ -285,4 +285,4 @@ Vector<float> visualkey_get_values(PointerRNA *ptr, PropertyRNA *prop)
/* as the function hasn't returned yet, read value from system in the default way */
return ANIM_setting_get_rna_values(ptr, prop);
}
} // namespace blender::animrig
} // namespace blender::animrig

45
source/blender/blenkernel/intern/pbvh_bmesh.cc
View File

@ -199,7 +199,7 @@ static BMVert *bm_vert_hash_lookup_chain(GHash *deleted_verts, BMVert *v)
/****************************** Building ******************************/
/* Update node data after splitting. */
/** Update node data after splitting. */
static void pbvh_bmesh_node_finalize(PBVH *pbvh,
const int node_index,
const int cd_vert_node_offset,
@ -250,7 +250,7 @@ static void pbvh_bmesh_node_finalize(PBVH *pbvh,
n->flag |= PBVH_UpdateNormals;
}
/* Recursively split the node if it exceeds the leaf_limit. */
/** Recursively split the node if it exceeds the leaf_limit. */
static void pbvh_bmesh_node_split(PBVH *pbvh, const Span<BBC> bbc_array, int node_index)
{
const int cd_vert_node_offset = pbvh->cd_vert_node_offset;
@ -360,7 +360,7 @@ static void pbvh_bmesh_node_split(PBVH *pbvh, const Span<BBC> bbc_array, int nod
n->orig_vb = n->vb;
}
/* Recursively split the node if it exceeds the leaf_limit. */
/** Recursively split the node if it exceeds the leaf_limit. */
static bool pbvh_bmesh_node_limit_ensure(PBVH *pbvh, int node_index)
{
PBVHNode &node = pbvh->nodes[node_index];
@ -441,7 +441,7 @@ static BMVert *pbvh_bmesh_vert_create(PBVH *pbvh,
BLI_assert((pbvh->nodes.size() == 1 || node_index) && node_index <= pbvh->nodes.size());
/* Avoid initializing customdata because its quite involved. */
/* Avoid initializing custom-data because its quite involved. */
BMVert *v = BM_vert_create(pbvh->header.bm, co, nullptr, BM_CREATE_NOP);
BM_data_interp_from_verts(pbvh->header.bm, v1, v2, v, 0.5f);
@ -515,7 +515,7 @@ static int pbvh_bmesh_node_vert_use_count_at_most(PBVH *pbvh,
return count;
}
/* Return a node that uses vertex 'v' other than its current owner. */
/** Return a node that uses vertex `v` other than its current owner. */
static PBVHNode *pbvh_bmesh_vert_other_node_find(PBVH *pbvh, BMVert *v)
{
PBVHNode *current_node = pbvh_bmesh_node_from_vert(pbvh, v);
@ -744,7 +744,7 @@ static bool edge_queue_tri_in_circle(const EdgeQueue *q, BMFace *f)
return len_squared_v3v3(q->center_proj, c) <= q->radius_squared;
}
/* Return true if the vertex mask is less than 1.0, false otherwise. */
/** Return true if the vertex mask is less than 1.0, false otherwise. */
static bool check_mask(EdgeQueueContext *eq_ctx, BMVert *v)
{
return BM_ELEM_CD_GET_FLOAT(v, eq_ctx->cd_vert_mask_offset) < 1.0f;
@ -774,7 +774,7 @@ static void edge_queue_insert(EdgeQueueContext *eq_ctx, BMEdge *e, float priorit
}
}
/* Return true if the edge is a boundary edge: both its vertices are on a boundary. */
/** Return true if the edge is a boundary edge: both its vertices are on a boundary. */
static bool is_boundary_edge(const BMEdge &edge)
{
if (edge.head.hflag & BM_ELEM_SEAM) {
@ -806,7 +806,7 @@ static bool is_boundary_vert(const BMVert &vertex)
return false;
}
/* Return true if at least one of the edge vertices is adjacent to a boundary. */
/** Return true if at least one of the edge vertices is adjacent to a boundary. */
static bool is_edge_adjacent_to_boundary(const BMEdge &edge)
{
return is_boundary_vert(*edge.v1) || is_boundary_vert(*edge.v2);
@ -1043,7 +1043,8 @@ static void long_edge_queue_create(EdgeQueueContext *eq_ctx,
}
}
/* Create a priority queue containing vertex pairs connected by a
/**
* Create a priority queue containing vertex pairs connected by a
* short edge as defined by PBVH.bm_min_edge_len.
*
* Only nodes marked for topology update are checked, and in those
@ -1161,8 +1162,7 @@ static void pbvh_bmesh_split_edge(EdgeQueueContext *eq_ctx, PBVH *pbvh, BMEdge *
pbvh_bmesh_vert_ownership_transfer(pbvh, &pbvh->nodes[ni], v_new);
}
/**
* The 2 new faces created and assigned to `f_new` have their
/* The 2 new faces created and assigned to `f_new` have their
* verts & edges shuffled around.
*
* - faces wind anticlockwise in this example.
@ -1297,11 +1297,11 @@ static bool vert_in_face_adjacent_to_edge(BMVert &vert, BMEdge &edge)
*
* This function is to be called before faces adjacent to \a e are deleted.
* This function only handles edge attributes and does not handle face deletion.
*
* \param del_face: Face which is adjacent to \a v_del and will form a flap when merging \a v_del
* to \a v_conn.
* to \a v_conn.
* \param flap_face: Face which is adjacent to \a v_conn and will form a flap when merging \a v_del
* to \a v_conn.
* to \a v_conn.
* \param e: An edge which is being collapsed. It connects \a v_del and \a v_conn.
* \param v_del: A vertex which will be removed after the edge collapse.
* \param l_del: A loop of del_face which is adjacent to v_del.
@ -1316,7 +1316,6 @@ static void merge_flap_edge_data(BMesh &bm,
BMVert *v_conn)
{
/*
*
* v_del
* +
* del_face . / |
@ -1335,11 +1334,11 @@ static void merge_flap_edge_data(BMesh &bm,
UNUSED_VARS_NDEBUG(del_face, flap_face);
/* Faces around `e` (which connects `v_del` to `v_conn`) are to the handled separately from this
* function. Help troubleshooting cases where these faces are mistakingly considered flaps. */
* function. Help troubleshooting cases where these faces are mistakenly considered flaps. */
BLI_assert(!BM_edge_in_face(e, del_face));
BLI_assert(!BM_edge_in_face(e, flap_face));
/* The l_del->next->v and l_del->prev->v are v1 and v2, but in an unknown order. */
/* The `l_del->next->v` and `l_del->prev->v` are v1 and v2, but in an unknown order. */
BMEdge *edge_v1_v2 = BM_edge_exists(l_del->next->v, l_del->prev->v);
if (!edge_v1_v2) {
CLOG_WARN(&LOG, "Unable to find edge shared between deleting and flap faces");
@ -1404,11 +1403,13 @@ static BMVert *find_outer_flap_vert(BMFace &face)
return flap_vert;
}
/* If the `del_face` is a flap, merge edge data from edges adjacent to "corner" vertex into the
/**
* If the `del_face` is a flap, merge edge data from edges adjacent to "corner" vertex into the
* other edge. The "corner" as it is an "outer", or a vertex which will become loose when the
* `del_face` and its edges are removed.
*
* If the face is not a flap then this function does nothing. */
* If the face is not a flap then this function does nothing.
*/
static void try_merge_flap_edge_data_before_dissolve(BMesh &bm, BMFace &face)
{
/*
@ -1448,11 +1449,11 @@ static void try_merge_flap_edge_data_before_dissolve(BMesh &bm, BMFace &face)
*
* This function is to be called before faces adjacent to \a e are deleted.
* This function only handles edge attributes. and does not handle face deletion.
*
* \param del_face: Face which is adjacent to \a v_del and will be deleted as part of merging
* \a v_del to \a v_conn.
* \a v_del to \a v_conn.
* \param new_face: A new face which is created from \a del_face by replacing \a v_del with
* \a v_conn.
* \a v_conn.
* \param v_del: A vertex which will be removed after the edge collapse.
* \param l_del: A loop of del_face which is adjacent to v_del.
* \param v_conn: A vertex which into which geometry is reconnected to after the edge collapse.

10
source/blender/blenlib/intern/string_utf8.cc
View File

@ -194,14 +194,14 @@ ptrdiff_t BLI_str_utf8_invalid_byte(const char *str, size_t length)
/* Check for overlong sequences for each different length */
switch (ab) {
case 1:
/* Check for: XX00 000X. */
/* Check for: `XX00 000X`. */
if ((c & 0x3e) == 0) {
goto utf8_error;
}
continue; /* We know there aren't any more bytes to check */
case 2:
/* Check for: 1110 0000, XX0X XXXX. */
/* Check for: `1110 0000, XX0X XXXX`. */
if (c == 0xe0 && (*p & 0x20) == 0) {
goto utf8_error;
}
@ -243,21 +243,21 @@ ptrdiff_t BLI_str_utf8_invalid_byte(const char *str, size_t length)
break;
case 3:
/* Check for: 1111 0000, XX00 XXXX. */
/* Check for: `1111 0000, XX00 XXXX`. */
if (c == 0xf0 && (*p & 0x30) == 0) {
goto utf8_error;
}
break;
case 4:
/* Check for 1111 1000, XX00 0XXX. */
/* Check for `1111 1000, XX00 0XXX`. */
if (c == 0xf8 && (*p & 0x38) == 0) {
goto utf8_error;
}
break;
case 5:
/* Check for: 1111 1100, XX00 00XX. */
/* Check for: `1111 1100, XX00 00XX`. */
if (c == 0xfc && (*p & 0x3c) == 0) {
goto utf8_error;
}

7
source/blender/blenlib/intern/winstuff_registration.cc
View File

@ -19,7 +19,8 @@
# include "utf_winfunc.hh"
# include "utfconv.hh"
/* Pinning : Windows allows people to pin an application to their taskbar, when a user pins
/**
* Pinning: Windows allows people to pin an application to their taskbar, when a user pins
* blender, the data we set in `GHOST_WindowWin32::registerWindowAppUserModelProperties` is used
* which includes the path to the `blender-launcher.exe`. Now once that shortcut is created on
* the taskbar, this will never be updated, if people remove blender and install it again to a
@ -27,8 +28,8 @@
* shortcut on the taskbar points to a no longer existing blender installation. Now you may think,
* just un-pin and re-pin that should clear that right up! It doesn't, it'll keep using the
* outdated path till the end of time and there's no window API call we can do to update this
* information. However this shortcut is stored in the user profile in a sub-foder we can easily
* query, from there, we can iterate over all files, look for the one that has our appid in it,
* information. However this shortcut is stored in the user profile in a sub-folder we can easily
* query, from there, we can iterate over all files, look for the one that has our APP-ID in it,
* and when we find it, update the path to the blender launcher to the current installation, bit
* of a hack, but Microsoft seemingly offers no other way to deal with this problem.
*

2
source/blender/blenlib/tests/BLI_string_utils_test.cc
View File

@ -78,4 +78,4 @@ TEST(BLI_string_utils, BLI_uniquename_cb)
}
}
} // namespace blender
} // namespace blender

2
source/blender/blenloader/intern/versioning_400.cc
View File

@ -265,7 +265,7 @@ static void version_principled_bsdf_update_animdata(ID *owner_id, bNodeTree *ntr
/* Order is important here: If we e.g. want to change A->B and B->C, but perform A->B first,
* then later we don't know whether a B entry is an original B (and therefore should be
* changed to C) or used to be A and was already handled.
* In practise, going reverse mostly works, the two notable dependency chains are:
* In practice, going reverse mostly works, the two notable dependency chains are:
* - 8->13, then 2->8, then 9->2 (13 was changed before)
* - 1->9, then 6->1 (9 was changed before)
* - 4->10, then 21->4 (10 was changed before)

2
source/blender/draw/engines/eevee_next/shaders/eevee_hiz_update_comp.glsl
View File

@ -125,4 +125,4 @@ void main()
// downsample_level(out_mip_10, 10);
}
}
}
}

2
source/blender/draw/engines/eevee_next/shaders/eevee_ray_trace_screen_lib.glsl
View File

@ -220,4 +220,4 @@ ScreenTraceHitData raytrace_planar(RayTraceData rt_data,
return result;
}
#endif
#endif

2
source/blender/gpu/vulkan/vk_command_buffers.hh
View File

@ -166,7 +166,7 @@ class VKCommandBuffers : public NonCopyable, NonMovable {
void ensure_no_compute_commands();
/**
* Ensire that no draw_commands are scheduled.
* Ensure that no draw_commands are scheduled.
*
* To ensure correct operation all draw commands should be flushed when adding a new compute
* command.