diff --git a/intern/guardedalloc/MEM_guardedalloc.h b/intern/guardedalloc/MEM_guardedalloc.h index a8eca7539a9..0357a29dce0 100644 --- a/intern/guardedalloc/MEM_guardedalloc.h +++ b/intern/guardedalloc/MEM_guardedalloc.h @@ -19,7 +19,7 @@ * back-up in case the linked-list related data is lost. * * It also provides C++ template versions of [cm]alloc and related API, - * which prodives improved type safety, ensures that the allocated types + * which provides improved type safety, ensures that the allocated types * are trivial, and reduces the casting verbosity by directly returning * a pointer of the expected type. * @@ -52,7 +52,7 @@ extern "C" { * void pointers and explicit size values). * * This API should usually not be used anymore in C++ code, unless some form of raw memory - * mamangement is necessary (e.g. for allocation of various ID types based on their + * management is necessary (e.g. for allocation of various ID types based on their * #IDTypeInfo::struct_size data). * * \{ */ @@ -170,7 +170,7 @@ extern void *(*MEM_calloc_arrayN_aligned)( ATTR_NONNULL(4); #ifdef __cplusplus -/* Implicitely uses the templated, type-safe version of #MEM_freeN, unless `v` is `void *`. */ +/** Implicitly uses the templated, type-safe version of #MEM_freeN, unless `v` is `void *`. */ # define MEM_SAFE_FREE(v) \ do { \ if (v) { \ @@ -330,7 +330,7 @@ void MEM_use_guarded_allocator(void); * Defines some `new`/`delete`-like helpers, which allocate/free memory using `MEM_guardedalloc`, * and construct/destruct the objects. * - * When possible, it is prefferred to use these, even on trivial types, as it makes potential + * When possible, it is preferred to use these, even on trivial types, as it makes potential * future changes to these types less disruptive, and is overall closer to standard C++ data * creation and destruction. * diff --git a/source/blender/blenlib/intern/kdtree_impl.h b/source/blender/blenlib/intern/kdtree_impl.h index 0260e6fc41d..69cf386600c 100644 --- a/source/blender/blenlib/intern/kdtree_impl.h +++ b/source/blender/blenlib/intern/kdtree_impl.h @@ -22,8 +22,8 @@ #define _BLI_KDTREE_CONCAT(MACRO_ARG1, MACRO_ARG2) _BLI_KDTREE_CONCAT_AUX(MACRO_ARG1, MACRO_ARG2) #define BLI_kdtree_nd_(id) _BLI_KDTREE_CONCAT(KDTREE_PREFIX_ID, _##id) -/* Put in anonymouse namespace to avoid violating one definition rule. - * Otherwise MEM_malloc_array can get defined once for multiple dimensions, +/* Put in anonymous namespace to avoid violating one definition rule. + * Otherwise `MEM_malloc_array` can get defined once for multiple dimensions, * with different node sizes. */ namespace { diff --git a/source/blender/depsgraph/DEG_depsgraph_debug.hh b/source/blender/depsgraph/DEG_depsgraph_debug.hh index 44691537b97..7b79fe11712 100644 --- a/source/blender/depsgraph/DEG_depsgraph_debug.hh +++ b/source/blender/depsgraph/DEG_depsgraph_debug.hh @@ -67,8 +67,9 @@ bool DEG_debug_graph_relations_validate(Depsgraph *graph, /** Perform consistency check on the graph. */ bool DEG_debug_consistency_check(Depsgraph *graph); -/** Convert bitflag representation of recalculation flags to string that consists of human-readable - * names of recalculation bits that are set in the given mask. +/** + * Convert bit-flag representation of recalculation flags to string + * that consists of human-readable names of recalculation bits that are set in the given mask. * * If flags == 0 the result is "NONE". * diff --git a/source/blender/editors/include/UI_interface_types.hh b/source/blender/editors/include/UI_interface_types.hh index 5e5796939aa..9ce071e00b4 100644 --- a/source/blender/editors/include/UI_interface_types.hh +++ b/source/blender/editors/include/UI_interface_types.hh @@ -24,7 +24,7 @@ using uiMenuHandleFunc = void (*)(bContext *C, void *arg, int event); /** * Used for cycling menu values without opening the menu (Ctrl-Wheel). * \param direction: forward or backwards [1 / -1]. - * \param arg1: uiBut.poin (as with #uiMenuCreateFunc). + * \param arg1: `uiBut.poin` (as with #uiMenuCreateFunc). * \return true when the button was changed. */ using uiMenuStepFunc = bool (*)(bContext *C, int direction, void *arg1); diff --git a/source/blender/editors/render/render_internal.cc b/source/blender/editors/render/render_internal.cc index dd55e59502d..803c1d1a6f8 100644 --- a/source/blender/editors/render/render_internal.cc +++ b/source/blender/editors/render/render_internal.cc @@ -523,7 +523,7 @@ static void image_renderinfo_cb(void *rjv, RenderStats *rs) rr = RE_AcquireResultRead(rj->re); if (rr) { - /* malloc OK here, stats_draw is not in tile threads */ + /* `malloc` is OK here, `stats_draw` is not in tile threads. */ if (rr->text == nullptr) { rr->text = MEM_calloc_arrayN(IMA_MAX_RENDER_TEXT_SIZE, "rendertext"); } diff --git a/source/blender/geometry/intern/mesh_boolean.cc b/source/blender/geometry/intern/mesh_boolean.cc index 00e56d63392..2bd71e6acf7 100644 --- a/source/blender/geometry/intern/mesh_boolean.cc +++ b/source/blender/geometry/intern/mesh_boolean.cc @@ -1164,7 +1164,7 @@ static void write_boolean_benchmark_time( const int num_tris_2 = mesh2 ? mesh2->corner_tris().size() : 0; const int threads = BLI_system_num_threads_override_get(); - /* Add header line if file doesn't exsit yet. */ + /* Add header line if file doesn't exist yet. */ bool first_time = false; if (!std::filesystem::exists(BENCHMARK_FILE)) { first_time = true; diff --git a/source/blender/geometry/intern/mesh_boolean_manifold.cc b/source/blender/geometry/intern/mesh_boolean_manifold.cc index 92f50ea8abe..46f60c6d085 100644 --- a/source/blender/geometry/intern/mesh_boolean_manifold.cc +++ b/source/blender/geometry/intern/mesh_boolean_manifold.cc @@ -164,10 +164,12 @@ static void dump_mesh(const Mesh *mesh, const std::string &name) } } -/* Holds cumulative offsets for the given elements of a number +/** + * Holds cumulative offsets for the given elements of a number * of concatenated Meshes. The sizes are one greater than the * number of meshes, so that the last value of each gives the - * total number of elements. */ + * total number of elements. + */ struct MeshOffsets { Array vert_start; Array face_start; @@ -200,7 +202,8 @@ MeshOffsets::MeshOffsets(Span meshes) this->corner_offsets = OffsetIndices(this->corner_start); } -/* Create and return the Manifold library's internal #Manifold class instance +/** + * Create and return the Manifold library's internal #Manifold class instance * to represent the subset \a joined_mesh which came from the input * mesh with index \a mesh_index. We can tell which elements are in the * subset using \a mesh_offsets. @@ -273,8 +276,10 @@ static void get_manifold(Manifold &manifold, } } -/* Get all the Manifold data structures for each Mesh subset of \a joined_mesh that is indicated - * by a range of offsets in \a mesh_offsets. ß*/ +/** + * Get all the Manifold data structures for each Mesh subset of \a joined_mesh that is indicated + * by a range of offsets in \a mesh_offsets. ß + */ static void get_manifolds(MutableSpan manifolds, const Span meshes, const Span transforms, @@ -293,7 +298,7 @@ static void get_manifolds(MutableSpan manifolds, /* Transforming the original input meshes is a simple way to reuse the Mesh::corner_tris() cache * for un-transformed meshes. This should reduce memory usage and help to avoid unnecessary cache - * recomputations. */ + * re-computations. */ Array transformed_meshes(meshes_num); for (const int i : meshes.index_range()) { if (math::is_identity(transforms[i])) { @@ -340,7 +345,7 @@ struct OutFace { } }; -/* Data needed to build the final output Mesh. */ +/** Data needed to build the final output Mesh. */ struct MeshAssembly { /* Vertex positions, linearized (use vertpos_stride to multiply index). */ Span vertpos; @@ -353,11 +358,12 @@ struct MeshAssembly { Vector new_faces; }; -/* Arrays to find, for each index of a given type in the output mesh, +/** + * Arrays to find, for each index of a given type in the output mesh, * what is the corresponding index of a representative element in the joined mesh. * if there is no representative, a -1 is used. - * These are created lazily - if their current length is zero, then need to be - * created. */ + * These are created lazily - if their current length is zero, then need to be created. + */ class OutToInMaps { Array vertex_map_; Array face_map_; @@ -620,7 +626,7 @@ Span OutToInMaps::ensure_edge_map() } } /* It is possible that the output face and corresponding - * input face have opposite windings. So do all of the previous + * input face have opposite winding. So do all of the previous * again with the previous edge of input face but same edge of * output face. */ @@ -670,11 +676,12 @@ Span OutToInMaps::ensure_edge_map() return edge_map_; } -/* Most input faces should mape to face_group_inline or fewer output triangles. */ +/** Most input faces should map to face_group_inline or fewer output triangles. */ constexpr int face_group_inline = 4; -/* Return an array of length \a input_faces_num, where the ith entry - * is a Vector of the \a mgl triangles that derive from the ith input +/** + * Return an array of length \a input_faces_num, where the i'th entry + * is a Vector of the \a mgl triangles that derive from the i'th input * face (where i is an index in the concatenated input mesh face space. */ static Array> get_face_groups(const MeshGL &mgl, @@ -702,11 +709,13 @@ static Array> get_face_groups(const MeshGL &mgl, } # if 0 -* TODO: later */ -/* Return 1 if \a group is just the same oas the original face \a face_index +/* TODO: later */ +/** + * Return 1 if \a group is just the same as the original face \a face_index * in \a mesh. - * Return 2 if it is the same but with the noraal reversed. - * Return 0 otherwise. */ + * Return 2 if it is the same but with the normal reversed. + * Return 0 otherwise. + */ static uchar check_original_face(const Vector &group, const MeshGL &mgl, const Mesh *mesh, @@ -727,7 +736,7 @@ static uchar check_original_face(const Vector &group, int stride = mgl.numProp; for (const int t : group) { /* face_vert_index[i] will hold the position in input face face_index - * where the ith vertex of triangle t is (assuming that no position + * where the i'th vertex of triangle t is (assuming that no position * is exactly repeated in an output face). -1 if there is no such. */ Array face_vert_index(3); for (const int i : IndexRange(3)) { @@ -779,7 +788,8 @@ static OutFace make_out_face(const MeshGL &mgl, int tri_index, int orig_face) return ans; } -/* For face merging, there is this indexing space: +/** + * For face merging, there is this indexing space: * "group edge" index: linearized indices of edges in the * triangles in the group. * A SharedEdge has two such indices, with the assertion that @@ -805,7 +815,7 @@ struct SharedEdge { } }; -/* Canonical SharedEdge has v1 < v2. */ +/** Canonical SharedEdge has v1 < v2. */ static inline SharedEdge canon_shared_edge(int e1, int e2, int v1, int v2) { if (v1 < v2) { @@ -814,9 +824,11 @@ static inline SharedEdge canon_shared_edge(int e1, int e2, int v1, int v2) return SharedEdge(e2, e1, v2, v1); } -/* Special case of get_shared_edges when there are two faces. +/** + * Special case of get_shared_edges when there are two faces. * Return the version of SharedEdge where 0 <= e1 < 3 and 3 <= e2 < 6. - * If there is no shared edge, return SharedEdge(-1, -1, -1, -1). */ + * If there is no shared edge, return SharedEdge(-1, -1, -1, -1). + */ static SharedEdge get_shared_edge_from_pair(const OutFace &tri1, const OutFace &tri2) { /* There should be at most one shared edge between the tri1 and tri2. Find it. */ @@ -847,7 +859,8 @@ static SharedEdge get_shared_edge_from_pair(const OutFace &tri1, const OutFace & return shared_edge; } -/* Given a span of OutFaces, all triangles, find as many SharedEdge's as possible. +/** + * Given a span of OutFaces, all triangles, find as many SharedEdge's as possible. * A SharedEdge is one where it is in two triangles but with the vertices in opposite order. * The edge ids are given as indexes into all the edges of \a faces in order. */ @@ -873,7 +886,8 @@ static Vector get_shared_edges(Span faces) return ans; } -/* Return true if the splice of faces \a f1 and \a f2 forms a legal face (no repeated verts). +/** + * Return true if the splice of faces \a f1 and \a f2 forms a legal face (no repeated verts). * The splice will be between vertices \a v1 and \a v2, which are assumed to not be * repeated in the other face (since incoming faces are assumed legal). */ @@ -900,7 +914,8 @@ static bool is_legal_merge(const OutFace &f1, const OutFace &f2, int v1, int v2) return true; } -/* Try merging OutFaces \a f1 and \a f2, which should have a \a se as a shared edge. +/** + * Try merging OutFaces \a f1 and \a f2, which should have a \a se as a shared edge. * Assume the shared edge has v1,v2 in CCW order in f1, and in the opposite order in f2. * This involves splicing the two faces together and checking that there * is no repeated vertex if this is done. @@ -967,7 +982,7 @@ static bool try_merge_out_face_pair(OutFace &f1, const OutFace &f2, const Shared return true; } -/* Special case (for speed) merge_out_faces when faces has two triangles. */ +/** Special case (for speed) merge_out_faces when faces has two triangles. */ static void merge_out_face_pair(Vector &faces) { constexpr int dbg_level = 0; @@ -1015,7 +1030,8 @@ static void merge_out_face_pair(Vector &faces) faces.resize(1); } -/* Give a group of #OutFace's that are all from a same original mesh face, +/** + * Give a group of #OutFace's that are all from a same original mesh face, * remove as many dissolvable edges as possible while still keeping the faces legal. * A face is legal if it has no repeated vertices and has size at least 3. */ @@ -1117,7 +1133,8 @@ static void merge_out_faces(Vector &faces) } } -/* Build the MeshAssembly corresponding to \a mgl. +/** + * Build the MeshAssembly corresponding to \a mgl. * This involves: * (1) Pointing at output vertices. * (2) Making a map from output vertices to input vertices (using -1 if no match). @@ -1328,8 +1345,10 @@ static void interpolate_corner_attributes(bke::MutableAttributeAccessor &output_ } } -/* What mesh_id corresponds to a given face_id, assuming that the face_id - * is in one of the ranges of mesh_offsets.face_offsets. */ +/** + * What mesh_id corresponds to a given face_id, assuming that the face_id + * is in one of the ranges of mesh_offsets.face_offsets. + */ static inline int mesh_id_for_face(int face_id, const MeshOffsets &mesh_offsets) { for (const int mesh_id : mesh_offsets.face_offsets.index_range()) { @@ -1340,8 +1359,10 @@ static inline int mesh_id_for_face(int face_id, const MeshOffsets &mesh_offsets) return -1; } -/* Find the edges that are the result of interesecting one mesh with another, - * and add their indices to \a r_intersecting_edges. */ +/** + * Find the edges that are the result of intersecting one mesh with another, + * and add their indices to \a r_intersecting_edges. + */ static void get_intersecting_edges(Vector *r_intersecting_edges, const Mesh *mesh, OutToInMaps &out_to_in, @@ -1377,9 +1398,11 @@ static void get_intersecting_edges(Vector *r_intersecting_edges, } } -/* Return true if \a mesh is a plane. If it is, fill in *r_normal to be +/** + * Return true if \a mesh is a plane. If it is, fill in *r_normal to be * the plane's normal, and *r_origin_offset to be the vector that goes - * from the origin to the plane in the normal direction. */ + * from the origin to the plane in the normal direction. + */ static bool is_plane(const Mesh *mesh, float3 *r_normal, float *r_origin_offset) { if (mesh->faces_num != 1 && mesh->verts_num != 4) { @@ -1401,9 +1424,11 @@ static bool is_plane(const Mesh *mesh, float3 *r_normal, float *r_origin_offset) return false; } -/* Handle special case of one manifold mesh, which has been converted to +/** + * Handle special case of one manifold mesh, which has been converted to * \a manifold 0, and one plane, which has normalized normal \a normal - * and distance from origin \a origin_offset. */ + * and distance from origin \a origin_offset. + */ static MeshGL mesh_trim_manifold(Manifold &manifold0, float3 normal, float origin_offset, @@ -1425,10 +1450,11 @@ static MeshGL mesh_trim_manifold(Manifold &manifold0, return meshgl; } -/* Convert the meshgl that is the result of the boolean back into a +/** + * Convert the meshgl that is the result of the boolean back into a * Blender Mesh. * If \a r_intersecting_edges is not null, fill it with the edge indices - * of edges that saparate two different meshes of the input. + * of edges that separate two different meshes of the input. */ static Mesh *meshgl_to_mesh(MeshGL &mgl, const Mesh *joined_mesh, @@ -1519,7 +1545,7 @@ static Mesh *meshgl_to_mesh(MeshGL &mgl, /* Copy attributes from joined_mesh to elements they are mapped to * in the new mesh. For most attributes, if there is no input element * mapping to it, the attribute value is left at default. - * But for coerner attributes (most importantly, UV maps), missing + * But for corner attributes (most importantly, UV maps), missing * values are interpolated in their containing face. * We'll do corner interpolation in a separate pass so as to do * such attributes at once for a given face.