diff options
author | Campbell Barton <campbell@blender.org> | 2022-11-01 04:24:06 +0300 |
---|---|---|
committer | Campbell Barton <campbell@blender.org> | 2022-11-01 04:24:58 +0300 |
commit | afc091c3c4bc86d4bb6165cbcdc9f17129d743e8 (patch) | |
tree | 326fb5d27d4393bacad193b297b0386751a31993 | |
parent | ef76a67153c9670b42f3f8091bbf41388c5bbd73 (diff) |
Cleanup: spelling in comments
52 files changed, 128 insertions, 120 deletions
diff --git a/intern/cycles/blender/session.cpp b/intern/cycles/blender/session.cpp index f9a83b2dc4b..6641e2b8ac5 100644 --- a/intern/cycles/blender/session.cpp +++ b/intern/cycles/blender/session.cpp @@ -497,9 +497,9 @@ void BlenderSession::render_frame_finish() session->full_buffer_written_cb = function_null; /* The display driver is the source of drawing context for both drawing and possible graphics - * interop objects in the path trace. Once the frame is finished the OpenGL context might be - * freed form Blender side. Need to ensure that all GPU resources are freed prior to that - * point. + * interoperability objects in the path trace. Once the frame is finished the OpenGL context + * might be freed form Blender side. Need to ensure that all GPU resources are freed prior to + * that point. * Ideally would only do this when OpenGL context is actually destroyed, but there is no way to * know when this happens (at least in the code at the time when this comment was written). * The penalty of re-creating resources on every frame is unlikely to be noticed. */ diff --git a/intern/cycles/integrator/path_trace_work_gpu.cpp b/intern/cycles/integrator/path_trace_work_gpu.cpp index 48f6cf3c903..547e8d50a22 100644 --- a/intern/cycles/integrator/path_trace_work_gpu.cpp +++ b/intern/cycles/integrator/path_trace_work_gpu.cpp @@ -100,8 +100,8 @@ void PathTraceWorkGPU::alloc_integrator_soa() integrator_state_soa_volume_stack_size_ = max(integrator_state_soa_volume_stack_size_, requested_volume_stack_size); - /* Deterine the number of path states. Deferring this for as long as possible allows the backend - * to make better decisions about memory availability. */ + /* Determine the number of path states. Deferring this for as long as possible allows the + * back-end to make better decisions about memory availability. */ if (max_num_paths_ == 0) { size_t single_state_size = estimate_single_state_size(kernel_features); diff --git a/intern/ghost/intern/GHOST_SystemWayland.cpp b/intern/ghost/intern/GHOST_SystemWayland.cpp index 3073a8fe80d..5af9f5a0231 100644 --- a/intern/ghost/intern/GHOST_SystemWayland.cpp +++ b/intern/ghost/intern/GHOST_SystemWayland.cpp @@ -801,7 +801,9 @@ struct GWL_Display { /** * Free the #GWL_Display and it's related members. - * \note This may run on a partially initialized struct, so it can't be assumed all mebers are set. + * + * \note This may run on a partially initialized struct, + * so it can't be assumed all members are set. */ static void gwl_display_destroy(GWL_Display *display) { diff --git a/source/blender/blenkernel/BKE_armature.h b/source/blender/blenkernel/BKE_armature.h index ee0f41937e2..eff05e471aa 100644 --- a/source/blender/blenkernel/BKE_armature.h +++ b/source/blender/blenkernel/BKE_armature.h @@ -34,9 +34,9 @@ typedef struct EditBone { /** User-Defined Properties on this Bone */ struct IDProperty *prop; /** - * Editbones have a one-way link (i.e. children refer + * Edit-bones have a one-way link (i.e. children refer * to parents. This is converted to a two-way link for - * normal bones when leaving editmode. + * normal bones when leaving edit-mode. */ struct EditBone *parent; /** (64 == MAXBONENAME) */ diff --git a/source/blender/blenkernel/BKE_key.h b/source/blender/blenkernel/BKE_key.h index 0fe351c0aa4..6cae56b775f 100644 --- a/source/blender/blenkernel/BKE_key.h +++ b/source/blender/blenkernel/BKE_key.h @@ -167,9 +167,9 @@ void BKE_keyblock_update_from_offset(const struct Object *ob, * Move shape key from org_index to new_index. Safe, clamps index to valid range, * updates reference keys, the object's active shape index, * the 'frame' value in case of absolute keys, etc. - * Note indices are expected in real values (not 'fake' shapenr +1 ones). + * Note indices are expected in real values (not *fake* `shapenr +1` ones). * - * \param org_index: if < 0, current object's active shape will be used as skey to move. + * \param org_index: if < 0, current object's active shape will be used as shape-key to move. * \return true if something was done, else false. */ bool BKE_keyblock_move(struct Object *ob, int org_index, int new_index); diff --git a/source/blender/blenkernel/BKE_pointcache.h b/source/blender/blenkernel/BKE_pointcache.h index efb8c2a9bb1..4331a25c112 100644 --- a/source/blender/blenkernel/BKE_pointcache.h +++ b/source/blender/blenkernel/BKE_pointcache.h @@ -293,6 +293,7 @@ void BKE_ptcache_ids_from_object(struct ListBase *lb, bool BKE_ptcache_object_has(struct Scene *scene, struct Object *ob, int duplis); /************ ID specific functions ************************/ + void BKE_ptcache_id_clear(PTCacheID *id, int mode, unsigned int cfra); bool BKE_ptcache_id_exist(PTCacheID *id, int cfra); int BKE_ptcache_id_reset(struct Scene *scene, PTCacheID *id, int mode); diff --git a/source/blender/blenkernel/BKE_undo_system.h b/source/blender/blenkernel/BKE_undo_system.h index f3a929dc5b9..5d1a27f8ba0 100644 --- a/source/blender/blenkernel/BKE_undo_system.h +++ b/source/blender/blenkernel/BKE_undo_system.h @@ -75,7 +75,7 @@ typedef struct UndoStep { /** Some situations require the global state to be stored, edge cases when exiting modes. */ bool use_memfile_step; /** When this is true, undo/memfile read code is allowed to re-use old data-blocks for unchanged - * IDs, and existing depsgraphes. This has to be forbidden in some cases (like renamed IDs). */ + * IDs, and existing depsgraphs. This has to be forbidden in some cases (like renamed IDs). */ bool use_old_bmain_data; /** For use by undo systems that accumulate changes (mesh-sculpt & image-painting). */ bool is_applied; diff --git a/source/blender/blenkernel/intern/blendfile.c b/source/blender/blenkernel/intern/blendfile.c index 85a43b7c479..8b0d3f2e92e 100644 --- a/source/blender/blenkernel/intern/blendfile.c +++ b/source/blender/blenkernel/intern/blendfile.c @@ -186,7 +186,7 @@ static void setup_app_data(bContext *C, clean_paths(bfd->main); } - /* XXX here the complex windowmanager matching */ + /* The following code blocks performs complex window-manager matching. */ /* no load screens? */ if (mode != LOAD_UI) { diff --git a/source/blender/blenkernel/intern/layer.c b/source/blender/blenkernel/intern/layer.c index 06d69b6ff61..5b54f16661c 100644 --- a/source/blender/blenkernel/intern/layer.c +++ b/source/blender/blenkernel/intern/layer.c @@ -614,7 +614,7 @@ static bool layer_collection_hidden(ViewLayer *view_layer, LayerCollection *lc) return true; } - /* Check visiblilty restriction flags */ + /* Check visibility restriction flags */ if (lc->flag & LAYER_COLLECTION_HIDE || lc->collection->flag & COLLECTION_HIDE_VIEWPORT) { return true; } diff --git a/source/blender/blenkernel/intern/lib_id_delete.c b/source/blender/blenkernel/intern/lib_id_delete.c index 1a80376f482..c7643c56212 100644 --- a/source/blender/blenkernel/intern/lib_id_delete.c +++ b/source/blender/blenkernel/intern/lib_id_delete.c @@ -293,14 +293,14 @@ static size_t id_delete(Main *bmain, const bool do_tagged_deletion) * is never affected). */ for (ID *id = tagged_deleted_ids.first; id; id = id->next) { id->tag |= LIB_TAG_NO_MAIN; - /* Usercount needs to be reset artificially, since some usages may not be cleared in batch + /* User-count needs to be reset artificially, since some usages may not be cleared in batch * deletion (typically, if one deleted ID uses another deleted ID, this may not be cleared by * remapping code, depending on order in which these are handled). */ id->us = ID_FAKE_USERS(id); } } else { - /* First tag all datablocks directly from target lib. + /* First tag all data-blocks directly from target lib. * Note that we go forward here, since we want to check dependencies before users * (e.g. meshes before objects). * Avoids to have to loop twice. */ diff --git a/source/blender/blenkernel/intern/mask_rasterize.c b/source/blender/blenkernel/intern/mask_rasterize.c index 55834d5cf4e..adc0eb5f78c 100644 --- a/source/blender/blenkernel/intern/mask_rasterize.c +++ b/source/blender/blenkernel/intern/mask_rasterize.c @@ -521,7 +521,7 @@ static void layer_bucket_init(MaskRasterLayer *layer, const float pixel_size) } if (1) { - /* now convert linknodes into arrays for faster per pixel access */ + /* Now convert link-nodes into arrays for faster per pixel access. */ uint **buckets_face = MEM_mallocN(bucket_tot * sizeof(*buckets_face), __func__); uint bucket_index; @@ -1186,7 +1186,7 @@ void BKE_maskrasterize_handle_init(MaskRasterHandle *mr_handle, // printf("tris %d, feather tris %d\n", sf_tri_tot, tot_feather_quads); } - /* add trianges */ + /* Add triangles. */ BLI_scanfill_end_arena(&sf_ctx, sf_arena); } diff --git a/source/blender/blenkernel/intern/material.c b/source/blender/blenkernel/intern/material.c index 51e27f173c8..59530a6d6a6 100644 --- a/source/blender/blenkernel/intern/material.c +++ b/source/blender/blenkernel/intern/material.c @@ -1450,7 +1450,7 @@ static bool fill_texpaint_slots_cb(bNode *node, void *userdata) NodeTexImage *storage = (NodeTexImage *)node->storage; slot->interp = storage->interpolation; slot->image_user = &storage->iuser; - /* for new renderer, we need to traverse the treeback in search of a UV node */ + /* For new renderer, we need to traverse the tree back in search of a UV node. */ bNode *uvnode = nodetree_uv_node_recursive(node); if (uvnode) { @@ -1561,7 +1561,7 @@ void BKE_texpaint_slot_refresh_cache(Scene *scene, Material *ma, const struct Ob } /* COW needed when adding texture slot on an object with no materials. - * But do it only when slots actually change to avoid continuous depsgrap updates. */ + * But do it only when slots actually change to avoid continuous depsgraph updates. */ if (ma->tot_slots != prev_tot_slots || ma->paint_active_slot != prev_paint_active_slot || ma->paint_clone_slot != prev_paint_clone_slot || (ma->texpaintslot && prev_texpaintslot && diff --git a/source/blender/blenkernel/intern/pointcache.c b/source/blender/blenkernel/intern/pointcache.c index bb9a0f458b9..868cdde6d01 100644 --- a/source/blender/blenkernel/intern/pointcache.c +++ b/source/blender/blenkernel/intern/pointcache.c @@ -2611,7 +2611,7 @@ void BKE_ptcache_id_clear(PTCacheID *pid, int mode, uint cfra) } #endif - /* clear all files in the temp dir with the prefix of the ID and the ".bphys" suffix */ + /* Clear all files in the temp dir with the prefix of the ID and the `.bphys` suffix. */ switch (mode) { case PTCACHE_CLEAR_ALL: case PTCACHE_CLEAR_BEFORE: @@ -2775,7 +2775,7 @@ void BKE_ptcache_id_time( /* time handling for point cache: * - simulation time is scaled by result of bsystem_time * - for offsetting time only time offset is taken into account, since - * that's always the same and can't be animated. a timeoffset which + * that's always the same and can't be animated. a time-offset which * varies over time is not simple to support. * - field and motion blur offsets are currently ignored, proper solution * is probably to interpolate results from two frames for that .. diff --git a/source/blender/blenkernel/intern/screen.c b/source/blender/blenkernel/intern/screen.c index 3e5dbc47c40..2c896788b20 100644 --- a/source/blender/blenkernel/intern/screen.c +++ b/source/blender/blenkernel/intern/screen.c @@ -304,7 +304,7 @@ IDTypeInfo IDType_ID_SCR = { /* ************ Space-type/region-type handling ************** */ -/* keep global; this has to be accessible outside of windowmanager */ +/** Keep global; this has to be accessible outside of window-manager. */ static ListBase spacetypes = {NULL, NULL}; /* not SpaceType itself */ diff --git a/source/blender/blenkernel/intern/softbody.c b/source/blender/blenkernel/intern/softbody.c index 14a7d26a354..b35031b9a88 100644 --- a/source/blender/blenkernel/intern/softbody.c +++ b/source/blender/blenkernel/intern/softbody.c @@ -133,9 +133,9 @@ typedef struct SB_thread_context { #define BSF_INTERSECT 1 /* edge intersects collider face */ -/* private definitions for bodypoint states */ -#define SBF_DOFUZZY 1 /* Bodypoint do fuzzy. */ -#define SBF_OUTOFCOLLISION 2 /* Bodypoint does not collide. */ +/* private definitions for body-point states */ +#define SBF_DOFUZZY 1 /* Body-point do fuzzy. */ +#define SBF_OUTOFCOLLISION 2 /* Body-point does not collide. */ #define BFF_INTERSECT 1 /* collider edge intrudes face. */ #define BFF_CLOSEVERT 2 /* collider vertex repulses face. */ diff --git a/source/blender/blenkernel/intern/writeffmpeg.c b/source/blender/blenkernel/intern/writeffmpeg.c index 0842125932b..ee827cd8cd4 100644 --- a/source/blender/blenkernel/intern/writeffmpeg.c +++ b/source/blender/blenkernel/intern/writeffmpeg.c @@ -1017,7 +1017,7 @@ static AVStream *alloc_audio_stream(FFMpegContext *context, return NULL; } - /* need to prevent floating point exception when using vorbis audio codec, + /* Need to prevent floating point exception when using VORBIS audio codec, * initialize this value in the same way as it's done in FFmpeg itself (sergey) */ c->time_base.num = 1; c->time_base.den = c->sample_rate; diff --git a/source/blender/blenloader/intern/readfile.cc b/source/blender/blenloader/intern/readfile.cc index ec1768232c8..569798048f6 100644 --- a/source/blender/blenloader/intern/readfile.cc +++ b/source/blender/blenloader/intern/readfile.cc @@ -2143,7 +2143,7 @@ static void direct_link_id_common( BlendDataReader *reader, Library *current_library, ID *id, ID *id_old, const int tag) { if (!BLO_read_data_is_undo(reader)) { - /* When actually reading a file, we do want to reset/re-generate session uuids. + /* When actually reading a file, we do want to reset/re-generate session UUIDS. * In undo case, we want to re-use existing ones. */ id->session_uuid = MAIN_ID_SESSION_UUID_UNSET; } diff --git a/source/blender/bmesh/tools/bmesh_bevel.c b/source/blender/bmesh/tools/bmesh_bevel.c index 8da28af3ca7..c45f9dbe49c 100644 --- a/source/blender/bmesh/tools/bmesh_bevel.c +++ b/source/blender/bmesh/tools/bmesh_bevel.c @@ -2058,7 +2058,7 @@ static void get_profile_point(BevelParams *bp, const Profile *pro, int i, int ns } else { BLI_assert(is_power_of_2_i(nseg) && nseg <= bp->pro_spacing.seg_2); - /* Find spacing between subsamples in prof_co_2. */ + /* Find spacing between sub-samples in `prof_co_2`. */ int subsample_spacing = bp->pro_spacing.seg_2 / nseg; copy_v3_v3(r_co, pro->prof_co_2 + 3 * i * subsample_spacing); } diff --git a/source/blender/bmesh/tools/bmesh_wireframe.c b/source/blender/bmesh/tools/bmesh_wireframe.c index 14ec45f14b0..bdc36559e05 100644 --- a/source/blender/bmesh/tools/bmesh_wireframe.c +++ b/source/blender/bmesh/tools/bmesh_wireframe.c @@ -175,7 +175,7 @@ void BM_mesh_wireframe(BMesh *bm, BMVert **verts_neg = MEM_mallocN(sizeof(BMVert *) * totvert_orig, __func__); BMVert **verts_pos = MEM_mallocN(sizeof(BMVert *) * totvert_orig, __func__); - /* Will over-alloc, but makes for easy lookups by index to keep aligned. */ + /* Will over-allocate, but makes for easy lookups by index to keep aligned. */ BMVert **verts_boundary = use_boundary ? MEM_mallocN(sizeof(BMVert *) * totvert_orig, __func__) : NULL; diff --git a/source/blender/compositor/operations/COM_ConvertOperation.h b/source/blender/compositor/operations/COM_ConvertOperation.h index 16d1e2e6bb5..ffd02ed5a2f 100644 --- a/source/blender/compositor/operations/COM_ConvertOperation.h +++ b/source/blender/compositor/operations/COM_ConvertOperation.h @@ -98,7 +98,7 @@ class ConvertVectorToValueOperation : public ConvertBaseOperation { class ConvertRGBToYCCOperation : public ConvertBaseOperation { private: - /** YCbCr mode (Jpeg, ITU601, ITU709) */ + /** YCbCr mode (JPEG, ITU601, ITU709) */ int mode_; public: @@ -116,7 +116,7 @@ class ConvertRGBToYCCOperation : public ConvertBaseOperation { class ConvertYCCToRGBOperation : public ConvertBaseOperation { private: - /** YCbCr mode (Jpeg, ITU601, ITU709) */ + /** YCbCr mode (JPEG, ITU601, ITU709) */ int mode_; public: diff --git a/source/blender/editors/armature/armature_utils.c b/source/blender/editors/armature/armature_utils.c index 09174aa5e47..0465606e694 100644 --- a/source/blender/editors/armature/armature_utils.c +++ b/source/blender/editors/armature/armature_utils.c @@ -703,11 +703,11 @@ void ED_armature_from_edit(Main *bmain, bArmature *arm) newBone->inherit_scale_mode = eBone->inherit_scale_mode; if (eBone == arm->act_edbone) { - /* don't change active selection, this messes up separate which uses - * editmode toggle and can separate active bone which is de-selected originally */ + /* Don't change active selection, this messes up separate which uses + * edit-mode toggle and can separate active bone which is de-selected originally. */ - /* important, editbones can be active with only 1 point selected */ - /* newBone->flag |= BONE_SELECTED; */ + /* important, edit-bones can be active with only 1 point selected */ + /* `newBone->flag |= BONE_SELECTED;` */ arm->act_bone = newBone; } newBone->roll = 0.0f; diff --git a/source/blender/editors/armature/pose_transform.c b/source/blender/editors/armature/pose_transform.c index 9ed963f0c66..f92b72bbb66 100644 --- a/source/blender/editors/armature/pose_transform.c +++ b/source/blender/editors/armature/pose_transform.c @@ -361,7 +361,7 @@ static void applyarmature_reset_constraints(bPose *pose, const bool use_selected } } -/* set the current pose as the restpose */ +/* Set the current pose as the rest-pose. */ static int apply_armature_pose2bones_exec(bContext *C, wmOperator *op) { Main *bmain = CTX_data_main(C); @@ -404,10 +404,10 @@ static int apply_armature_pose2bones_exec(bContext *C, wmOperator *op) } } - /* Get editbones of active armature to alter */ + /* Get edit-bones of active armature to alter. */ ED_armature_to_edit(arm); - /* get pose of active object and move it out of posemode */ + /* Get pose of active object and move it out of pose-mode. */ pose = ob->pose; if (use_selected) { @@ -429,11 +429,11 @@ static int apply_armature_pose2bones_exec(bContext *C, wmOperator *op) } } - /* convert editbones back to bones, and then free the edit-data */ + /* Convert edit-bones back to bones, and then free the edit-data. */ ED_armature_from_edit(bmain, arm); ED_armature_edit_free(arm); - /* flush positions of posebones */ + /* Flush positions of pose-bones. */ BKE_pose_where_is(depsgraph, scene, ob); /* fix parenting of objects which are bone-parented */ diff --git a/source/blender/editors/interface/interface_handlers.c b/source/blender/editors/interface/interface_handlers.c index 7b6a623f53e..ac16d41dabe 100644 --- a/source/blender/editors/interface/interface_handlers.c +++ b/source/blender/editors/interface/interface_handlers.c @@ -3519,7 +3519,7 @@ static void ui_textedit_end(bContext *C, uiBut *but, uiHandleButtonData *data) static void ui_textedit_next_but(uiBlock *block, uiBut *actbut, uiHandleButtonData *data) { - /* label and roundbox can overlap real buttons (backdrops...) */ + /* Label and round-box can overlap real buttons (backdrops...). */ if (ELEM(actbut->type, UI_BTYPE_LABEL, UI_BTYPE_SEPR, @@ -3551,7 +3551,7 @@ static void ui_textedit_next_but(uiBlock *block, uiBut *actbut, uiHandleButtonDa static void ui_textedit_prev_but(uiBlock *block, uiBut *actbut, uiHandleButtonData *data) { - /* label and roundbox can overlap real buttons (backdrops...) */ + /* Label and round-box can overlap real buttons (backdrops...). */ if (ELEM(actbut->type, UI_BTYPE_LABEL, UI_BTYPE_SEPR, diff --git a/source/blender/editors/mesh/mesh_data.cc b/source/blender/editors/mesh/mesh_data.cc index 122b8fa7d89..b468360ff9b 100644 --- a/source/blender/editors/mesh/mesh_data.cc +++ b/source/blender/editors/mesh/mesh_data.cc @@ -787,7 +787,7 @@ static int mesh_customdata_custom_splitnormals_add_exec(bContext *C, wmOperator if (me->edit_mesh) { /* Tag edges as sharp according to smooth threshold if needed, - * to preserve autosmooth shading. */ + * to preserve auto-smooth shading. */ if (me->flag & ME_AUTOSMOOTH) { BM_edges_sharp_from_angle_set(me->edit_mesh->bm, me->smoothresh); } @@ -796,7 +796,7 @@ static int mesh_customdata_custom_splitnormals_add_exec(bContext *C, wmOperator } else { /* Tag edges as sharp according to smooth threshold if needed, - * to preserve autosmooth shading. */ + * to preserve auto-smooth shading. */ if (me->flag & ME_AUTOSMOOTH) { const Span<MVert> verts = me->verts(); MutableSpan<MEdge> edges = me->edges_for_write(); diff --git a/source/blender/editors/space_action/action_draw.c b/source/blender/editors/space_action/action_draw.c index eb56c6c4b54..343975919e2 100644 --- a/source/blender/editors/space_action/action_draw.c +++ b/source/blender/editors/space_action/action_draw.c @@ -104,7 +104,7 @@ void draw_channel_names(bContext *C, bAnimContext *ac, ARegion *region) UI_block_draw(C, block); } - /* free tempolary channels */ + /* Free temporary channels. */ ANIM_animdata_freelist(&anim_data); } diff --git a/source/blender/editors/space_graph/graph_draw.c b/source/blender/editors/space_graph/graph_draw.c index 41a8368152d..f8a0dff3a41 100644 --- a/source/blender/editors/space_graph/graph_draw.c +++ b/source/blender/editors/space_graph/graph_draw.c @@ -1446,7 +1446,7 @@ void graph_draw_channel_names(bContext *C, bAnimContext *ac, ARegion *region) GPU_blend(GPU_BLEND_NONE); } - /* free tempolary channels */ + /* Free temporary channels. */ ANIM_animdata_freelist(&anim_data); } diff --git a/source/blender/editors/space_nla/nla_draw.c b/source/blender/editors/space_nla/nla_draw.c index f57c9fead56..45bbe50eedd 100644 --- a/source/blender/editors/space_nla/nla_draw.c +++ b/source/blender/editors/space_nla/nla_draw.c @@ -905,7 +905,7 @@ void draw_nla_main_data(bAnimContext *ac, SpaceNla *snla, ARegion *region) } } - /* free tempolary channels */ + /* Free temporary channels. */ ANIM_animdata_freelist(&anim_data); } diff --git a/source/blender/editors/transform/transform_convert_armature.c b/source/blender/editors/transform/transform_convert_armature.c index 4b79625fa66..6fd25d26c31 100644 --- a/source/blender/editors/transform/transform_convert_armature.c +++ b/source/blender/editors/transform/transform_convert_armature.c @@ -306,8 +306,9 @@ static short pose_grab_with_ik_add(bPoseChannel *pchan) * just make things obey standard rotation locks too */ if (data->rootbone == 0) { for (bPoseChannel *pchan_iter = pchan; pchan_iter; pchan_iter = pchan_iter->parent) { - /* here, we set ik-settings for bone from pchan->protectflag */ - /* XXX: careful with quats/axis-angle rotations where we're locking 4d components. */ + /* Here, we set IK-settings for bone from `pchan->protectflag`. */ + /* XXX: careful with quaternion/axis-angle rotations + * where we're locking 4d components. */ if (pchan_iter->protectflag & OB_LOCK_ROTX) { pchan_iter->ikflag |= BONE_IK_NO_XDOF_TEMP; } diff --git a/source/blender/freestyle/intern/stroke/AdvancedFunctions1D.h b/source/blender/freestyle/intern/stroke/AdvancedFunctions1D.h index c19ac31ae4a..e5009f2b4f8 100644 --- a/source/blender/freestyle/intern/stroke/AdvancedFunctions1D.h +++ b/source/blender/freestyle/intern/stroke/AdvancedFunctions1D.h @@ -33,7 +33,7 @@ class DensityF1D : public UnaryFunction1D<double> { public: /** Builds the functor. * \param sigma: - * Thesigma used in DensityF0D and determining the window size used in each density query. + * The sigma used in DensityF0D and determining the window size used in each density query. * \param iType: * The integration method used to compute a single value from a set of values. * \param sampling: diff --git a/source/blender/freestyle/intern/view_map/ViewMapTesselator.h b/source/blender/freestyle/intern/view_map/ViewMapTesselator.h index 2da95d47912..c666e548884 100644 --- a/source/blender/freestyle/intern/view_map/ViewMapTesselator.h +++ b/source/blender/freestyle/intern/view_map/ViewMapTesselator.h @@ -89,7 +89,7 @@ class ViewMapTesselator { #endif }; -/** Class to tesselate the 2D projected silhouette */ +/** Class to tessellate the 2D projected silhouette */ class ViewMapTesselator2D : public ViewMapTesselator { public: inline ViewMapTesselator2D() : ViewMapTesselator() @@ -110,7 +110,7 @@ class ViewMapTesselator2D : public ViewMapTesselator { #endif }; -/** Class to tesselate the 3D silhouette */ +/** Class to tessellate the 3D silhouette */ class ViewMapTesselator3D : public ViewMapTesselator { public: inline ViewMapTesselator3D() : ViewMapTesselator() diff --git a/source/blender/gpu/metal/mtl_shader_generator.hh b/source/blender/gpu/metal/mtl_shader_generator.hh index 43890ca0170..63e2e6d5924 100644 --- a/source/blender/gpu/metal/mtl_shader_generator.hh +++ b/source/blender/gpu/metal/mtl_shader_generator.hh @@ -497,7 +497,7 @@ inline std::string get_stage_class_name(ShaderStage stage) inline bool is_builtin_type(std::string type) { /* Add Types as needed. */ - /* TODO(Metal): Consider replacing this with a switch and constexpr hash and switch. + /* TODO(Metal): Consider replacing this with a switch and `constexpr` hash and switch. * Though most efficient and maintainable approach to be determined. */ static std::map<std::string, eMTLDataType> glsl_builtin_types = { {"float", MTL_DATATYPE_FLOAT}, diff --git a/source/blender/gpu/metal/mtl_texture_util.mm b/source/blender/gpu/metal/mtl_texture_util.mm index 5ed7659f260..33a62e2e3ef 100644 --- a/source/blender/gpu/metal/mtl_texture_util.mm +++ b/source/blender/gpu/metal/mtl_texture_util.mm @@ -34,7 +34,7 @@ MTLPixelFormat gpu_texture_format_to_metal(eGPUTextureFormat tex_format) { switch (tex_format) { - /* Formats texture & renderbuffer. */ + /* Formats texture & render-buffer. */ case GPU_RGBA8UI: return MTLPixelFormatRGBA8Uint; case GPU_RGBA8I: diff --git a/source/blender/makesdna/DNA_customdata_types.h b/source/blender/makesdna/DNA_customdata_types.h index 287a9e2f3b9..0355ed3febe 100644 --- a/source/blender/makesdna/DNA_customdata_types.h +++ b/source/blender/makesdna/DNA_customdata_types.h @@ -116,7 +116,7 @@ typedef enum eCustomDataType { CD_PROP_BYTE_COLOR = 17, CD_TANGENT = 18, CD_MDISPS = 19, - CD_PREVIEW_MCOL = 20, /* for displaying weightpaint colors */ + CD_PREVIEW_MCOL = 20, /* For displaying weight-paint colors. */ /* CD_ID_MCOL = 21, */ /* CD_TEXTURE_MLOOPCOL = 22, */ /* UNUSED */ CD_CLOTH_ORCO = 23, @@ -209,7 +209,7 @@ typedef enum eCustomDataType { #define CD_MASK_HAIRLENGTH (1ULL << CD_HAIRLENGTH) -/** Multires loop data. */ +/** Multi-resolution loop data. */ #define CD_MASK_MULTIRES_GRIDS (CD_MASK_MDISPS | CD_GRID_PAINT_MASK) /* All data layers. */ diff --git a/source/blender/makesdna/DNA_layer_types.h b/source/blender/makesdna/DNA_layer_types.h index 827e07725a1..6ea35dfb770 100644 --- a/source/blender/makesdna/DNA_layer_types.h +++ b/source/blender/makesdna/DNA_layer_types.h @@ -134,13 +134,13 @@ typedef struct ViewLayerAOV { typedef struct ViewLayerLightgroup { struct ViewLayerLightgroup *next, *prev; - /* Name of the Lightgroup */ + /* Name of the Light-group. */ char name[64]; } ViewLayerLightgroup; -/* Lightgroup membership information. */ +/* Light-group membership information. */ typedef struct LightgroupMembership { - /* Name of the Lightgroup */ + /* Name of the Light-group. */ char name[64]; } LightgroupMembership; diff --git a/source/blender/makesdna/DNA_meta_types.h b/source/blender/makesdna/DNA_meta_types.h index d0c09a0d6ab..b4a66a46efe 100644 --- a/source/blender/makesdna/DNA_meta_types.h +++ b/source/blender/makesdna/DNA_meta_types.h @@ -42,7 +42,7 @@ typedef struct MetaElem { float rad2; /** Stiffness, how much of the element to fill. */ float s; - /** Old, only used for backwards compat. use dimensions now. */ + /** Old, only used for backwards compatibility. use dimensions now. */ float len; /** Matrix and inverted matrix. */ @@ -63,7 +63,7 @@ typedef struct MetaBall { /* material of the mother ball will define the material used of all others */ struct Material **mat; - /** Flag is enum for updates, flag2 is bitflags for settings. */ + /** Flag is enum for updates, flag2 is bit-flags for settings. */ char flag, flag2; short totcol; /** Used to store MB_AUTOSPACE. */ diff --git a/source/blender/makesdna/DNA_modifier_types.h b/source/blender/makesdna/DNA_modifier_types.h index 7625f04fefa..c4180071352 100644 --- a/source/blender/makesdna/DNA_modifier_types.h +++ b/source/blender/makesdna/DNA_modifier_types.h @@ -195,7 +195,7 @@ typedef struct LatticeModifierData { ModifierData modifier; struct Object *object; - /** Optional vertexgroup name, MAX_VGROUP_NAME. */ + /** Optional vertex-group name, #MAX_VGROUP_NAME. */ char name[64]; float strength; short flag; @@ -212,7 +212,7 @@ typedef struct CurveModifierData { ModifierData modifier; struct Object *object; - /** Optional vertexgroup name, MAX_VGROUP_NAME. */ + /** Optional vertex-group name, #MAX_VGROUP_NAME. */ char name[64]; /** Axis along which curve deforms. */ short defaxis; @@ -262,7 +262,7 @@ typedef struct MaskModifierData { /** Armature to use to in place of hardcoded vgroup. */ struct Object *ob_arm; - /** Name of vertex group to use to mask, MAX_VGROUP_NAME. */ + /** Name of vertex group to use to mask, #MAX_VGROUP_NAME. */ char vgroup[64]; /** Using armature or hardcoded vgroup. */ @@ -447,7 +447,7 @@ typedef struct BevelModifierData { float bevel_angle; float spread; /** if the MOD_BEVEL_VWEIGHT option is set, - * this will be the name of the vert group, MAX_VGROUP_NAME */ + * this will be the name of the vert group, #MAX_VGROUP_NAME */ char defgrp_name[64]; char _pad1[4]; @@ -565,7 +565,7 @@ typedef struct DisplaceModifierData { float strength; int direction; - /** MAX_VGROUP_NAME. */ + /** #MAX_VGROUP_NAME. */ char defgrp_name[64]; float midlevel; int space; @@ -635,7 +635,7 @@ typedef struct DecimateModifierData { /** (mode == MOD_DECIM_MODE_DISSOLVE). */ float angle; - /** MAX_VGROUP_NAME. */ + /** #MAX_VGROUP_NAME. */ char defgrp_name[64]; float defgrp_factor; short flag, mode; @@ -663,7 +663,7 @@ enum { typedef struct SmoothModifierData { ModifierData modifier; float fac; - /** MAX_VGROUP_NAME. */ + /** #MAX_VGROUP_NAME. */ char defgrp_name[64]; short flag, repeat; @@ -684,7 +684,7 @@ typedef struct CastModifierData { float fac; float radius; float size; - /** MAX_VGROUP_NAME. */ + /** #MAX_VGROUP_NAME. */ char defgrp_name[64]; short flag; /** Cast modifier projection type. */ @@ -725,7 +725,7 @@ typedef struct WaveModifierData { /* End MappingInfoModifierData. */ struct Object *objectcenter; - /** MAX_VGROUP_NAME. */ + /** #MAX_VGROUP_NAME. */ char defgrp_name[64]; short flag; @@ -760,7 +760,7 @@ typedef struct ArmatureModifierData { struct Object *object; /** Stored input of previous modifier, for vertex-group blending. */ float (*vert_coords_prev)[3]; - /** MAX_VGROUP_NAME. */ + /** #MAX_VGROUP_NAME. */ char defgrp_name[64]; } ArmatureModifierData; @@ -803,11 +803,11 @@ typedef struct HookModifierData { struct CurveMapping *curfalloff; - /** If NULL, it's using vertexgroup. */ + /** If NULL, it's using vertex-group. */ int *indexar; int indexar_num; float force; - /** Optional vertexgroup name, MAX_VGROUP_NAME. */ + /** Optional vertex-group name, #MAX_VGROUP_NAME. */ char name[64]; void *_pad1; } HookModifierData; @@ -946,7 +946,7 @@ typedef struct MeshDeformModifierData { /** Mesh object. */ struct Object *object; - /** Optional vertexgroup name, MAX_VGROUP_NAME. */ + /** Optional vertex-group name, #MAX_VGROUP_NAME. */ char defgrp_name[64]; short gridsize, flag; @@ -1124,7 +1124,7 @@ typedef struct ShrinkwrapModifierData { struct Object *target; /** Additional shrink target. */ struct Object *auxTarget; - /** Optional vertexgroup name, MAX_VGROUP_NAME. */ + /** Optional vertex-group name, #MAX_VGROUP_NAME. */ char vgroup_name[64]; /** Distance offset to keep from mesh/projection point. */ float keepDist; @@ -1171,9 +1171,9 @@ enum { /** #ShrinkwrapModifierData.shrinkOpts */ enum { - /** allow shrinkwrap to move the vertex in the positive direction of axis */ + /** Allow shrink-wrap to move the vertex in the positive direction of axis. */ MOD_SHRINKWRAP_PROJECT_ALLOW_POS_DIR = (1 << 0), - /** allow shrinkwrap to move the vertex in the negative direction of axis */ + /** Allow shrink-wrap to move the vertex in the negative direction of axis. */ MOD_SHRINKWRAP_PROJECT_ALLOW_NEG_DIR = (1 << 1), /** ignore vertex moves if a vertex ends projected on a front face of the target */ @@ -1207,7 +1207,7 @@ typedef struct SimpleDeformModifierData { /** Object to control the origin of modifier space coordinates. */ struct Object *origin; - /** Optional vertexgroup name, MAX_VGROUP_NAME. */ + /** Optional vertex-group name, #MAX_VGROUP_NAME. */ char vgroup_name[64]; /** Factors to control simple deforms. */ float factor; @@ -1250,7 +1250,7 @@ typedef struct ShapeKeyModifierData { typedef struct SolidifyModifierData { ModifierData modifier; - /** Name of vertex group to use, MAX_VGROUP_NAME. */ + /** Name of vertex group to use, #MAX_VGROUP_NAME. */ char defgrp_name[64]; char shell_defgrp_name[64]; char rim_defgrp_name[64]; @@ -1451,7 +1451,7 @@ typedef struct WarpModifierData { char bone_to[64]; struct CurveMapping *curfalloff; - /** Optional vertexgroup name, MAX_VGROUP_NAME. */ + /** Optional vertex-group name, #MAX_VGROUP_NAME. */ char defgrp_name[64]; float strength; float falloff_radius; @@ -1484,7 +1484,7 @@ typedef enum { typedef struct WeightVGEditModifierData { ModifierData modifier; - /** Name of vertex group to edit. MAX_VGROUP_NAME. */ + /** Name of vertex group to edit. #MAX_VGROUP_NAME. */ char defgrp_name[64]; /** Using MOD_WVG_EDIT_* flags. */ @@ -1504,7 +1504,7 @@ typedef struct WeightVGEditModifierData { /* Masking options. */ /** The global "influence", if no vgroup nor tex is used as mask. */ float mask_constant; - /** Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME. */ + /** Name of mask vertex group from which to get weight factors. #MAX_VGROUP_NAME. */ char mask_defgrp_name[64]; /* Texture masking. */ @@ -1540,9 +1540,9 @@ enum { typedef struct WeightVGMixModifierData { ModifierData modifier; - /** Name of vertex group to modify/weight. MAX_VGROUP_NAME. */ + /** Name of vertex group to modify/weight. #MAX_VGROUP_NAME. */ char defgrp_name_a[64]; - /** Name of other vertex group to mix in. MAX_VGROUP_NAME. */ + /** Name of other vertex group to mix in. #MAX_VGROUP_NAME. */ char defgrp_name_b[64]; /** Default weight value for first vgroup. */ float default_weight_a; @@ -1558,7 +1558,7 @@ typedef struct WeightVGMixModifierData { /* Masking options. */ /** The global "influence", if no vgroup nor tex is used as mask. */ float mask_constant; - /** Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME. */ + /** Name of mask vertex group from which to get weight factors. #MAX_VGROUP_NAME. */ char mask_defgrp_name[64]; /* Texture masking. */ @@ -1628,7 +1628,7 @@ enum { typedef struct WeightVGProximityModifierData { ModifierData modifier; - /** Name of vertex group to modify/weight. MAX_VGROUP_NAME. */ + /** Name of vertex group to modify/weight. #MAX_VGROUP_NAME. */ char defgrp_name[64]; /* Mapping stuff. */ @@ -1646,7 +1646,7 @@ typedef struct WeightVGProximityModifierData { /* Masking options. */ /** The global "influence", if no vgroup nor tex is used as mask. */ float mask_constant; - /** Name of mask vertex group from which to get weight factors. MAX_VGROUP_NAME. */ + /** Name of mask vertex group from which to get weight factors. #MAX_VGROUP_NAME. */ char mask_defgrp_name[64]; /* Texture masking. */ @@ -1840,7 +1840,7 @@ typedef struct LaplacianSmoothModifierData { float lambda, lambda_border; char _pad1[4]; - /** MAX_VGROUP_NAME. */ + /** #MAX_VGROUP_NAME. */ char defgrp_name[64]; short flag, repeat; } LaplacianSmoothModifierData; @@ -1887,7 +1887,7 @@ typedef struct CorrectiveSmoothModifierData { char smooth_type, rest_source; char _pad[6]; - /** MAX_VGROUP_NAME. */ + /** #MAX_VGROUP_NAME. */ char defgrp_name[64]; /* runtime-only cache */ @@ -1932,7 +1932,7 @@ typedef struct UVWarpModifierData { /** Optional name of bone target, MAX_ID_NAME-2. */ char bone_dst[64]; - /** Optional vertexgroup name, MAX_VGROUP_NAME. */ + /** Optional vertex-group name, #MAX_VGROUP_NAME. */ char vgroup_name[64]; /** MAX_CUSTOMDATA_LAYER_NAME. */ char uvlayer_name[64]; @@ -2013,7 +2013,7 @@ enum { typedef struct LaplacianDeformModifierData { ModifierData modifier; - /** MAX_VGROUP_NAME. */ + /** #MAX_VGROUP_NAME. */ char anchor_grp_name[64]; int verts_num, repeat; float *vertexco; @@ -2035,7 +2035,7 @@ enum { */ typedef struct WireframeModifierData { ModifierData modifier; - /** MAX_VGROUP_NAME. */ + /** #MAX_VGROUP_NAME. */ char defgrp_name[64]; float offset; float offset_fac; @@ -2059,7 +2059,7 @@ typedef struct WeldModifierData { /* The limit below which to merge vertices. */ float merge_dist; - /* Name of vertex group to use to mask, MAX_VGROUP_NAME. */ + /** Name of vertex group to use to mask, #MAX_VGROUP_NAME. */ char defgrp_name[64]; char mode; @@ -2107,7 +2107,7 @@ typedef struct DataTransferModifierData { /** See CDT_MIX_ enum in BKE_customdata.h. */ int mix_mode; float mix_factor; - /** MAX_VGROUP_NAME. */ + /** #MAX_VGROUP_NAME. */ char defgrp_name[64]; int flags; @@ -2130,7 +2130,7 @@ enum { /** Set Split Normals modifier. */ typedef struct NormalEditModifierData { ModifierData modifier; - /** MAX_VGROUP_NAME. */ + /** #MAX_VGROUP_NAME. */ char defgrp_name[64]; /** Source of normals, or center of ellipsoid. */ struct Object *target; @@ -2253,7 +2253,7 @@ enum { typedef struct WeightedNormalModifierData { ModifierData modifier; - /** MAX_VGROUP_NAME. */ + /** #MAX_VGROUP_NAME. */ char defgrp_name[64]; char mode, flag; short weight; diff --git a/source/blender/makesdna/DNA_node_types.h b/source/blender/makesdna/DNA_node_types.h index c7962db8198..74714cf7e41 100644 --- a/source/blender/makesdna/DNA_node_types.h +++ b/source/blender/makesdna/DNA_node_types.h @@ -931,7 +931,7 @@ typedef struct NodeImageMultiFileSocket { char path[1024]; ImageFormatData format; - /* multilayer output */ + /* Multi-layer output. */ /** EXR_TOT_MAXNAME-2 ('.' and channel char are appended). */ char layer[30]; char _pad2[2]; @@ -1273,7 +1273,7 @@ typedef struct CryptomatteLayer { typedef struct NodeCryptomatte_Runtime { /* Contains `CryptomatteLayer`. */ ListBase layers; - /* Temp storage for the cryptomatte picker. */ + /* Temp storage for the crypto-matte picker. */ float add[3]; float remove[3]; } NodeCryptomatte_Runtime; diff --git a/source/blender/makesdna/DNA_particle_types.h b/source/blender/makesdna/DNA_particle_types.h index 44f1d3479b1..c4f11905e10 100644 --- a/source/blender/makesdna/DNA_particle_types.h +++ b/source/blender/makesdna/DNA_particle_types.h @@ -465,7 +465,7 @@ enum { #define PART_REACT_MULTIPLE 2 //#define PART_LOOP 4 /* not used anymore */ -/* for dopesheet */ +/* For dope-sheet. */ #define PART_DS_EXPAND 8 #define PART_HAIR_REGROW 16 /* regrow hair for each frame */ diff --git a/source/blender/makesdna/DNA_space_types.h b/source/blender/makesdna/DNA_space_types.h index d2d20bcde78..4bb92e6fcc5 100644 --- a/source/blender/makesdna/DNA_space_types.h +++ b/source/blender/makesdna/DNA_space_types.h @@ -667,7 +667,7 @@ typedef struct SpaceSeq { struct SequencerPreviewOverlay preview_overlay; struct SequencerTimelineOverlay timeline_overlay; - /** Multiview current eye - for internal use. */ + /** Multi-view current eye - for internal use. */ char multiview_eye; char _pad2[7]; diff --git a/source/blender/makesdna/DNA_windowmanager_types.h b/source/blender/makesdna/DNA_windowmanager_types.h index 9b235fac049..7231a995f10 100644 --- a/source/blender/makesdna/DNA_windowmanager_types.h +++ b/source/blender/makesdna/DNA_windowmanager_types.h @@ -89,13 +89,13 @@ typedef struct Report { } Report; /** - * \note Saved in the wm, don't remove. + * \note Saved in the #wmWindowManager, don't remove. */ typedef struct ReportList { ListBase list; - /** eReportType. */ + /** #eReportType. */ int printlevel; - /** eReportType. */ + /** #eReportType. */ int storelevel; int flag; char _pad[4]; diff --git a/source/blender/makesdna/DNA_workspace_types.h b/source/blender/makesdna/DNA_workspace_types.h index e99f317f057..0cd1144b30d 100644 --- a/source/blender/makesdna/DNA_workspace_types.h +++ b/source/blender/makesdna/DNA_workspace_types.h @@ -199,8 +199,10 @@ typedef struct WorkSpaceInstanceHook { WorkSpace *active; struct WorkSpaceLayout *act_layout; - /** Needed because we can't change workspaces/layouts in running handler loop, - * it would break context. */ + /** + * Needed because we can't change work-spaces/layouts in running handler loop, + * it would break context. + */ WorkSpace *temp_workspace_store; struct WorkSpaceLayout *temp_layout_store; } WorkSpaceInstanceHook; diff --git a/source/blender/makesrna/intern/rna_armature.c b/source/blender/makesrna/intern/rna_armature.c index e6b1ea1321c..a2386205013 100644 --- a/source/blender/makesrna/intern/rna_armature.c +++ b/source/blender/makesrna/intern/rna_armature.c @@ -1129,7 +1129,7 @@ static void rna_def_bone_common(StructRNA *srna, int editbone) RNA_define_lib_overridable(false); } -/* err... bones should not be directly edited (only editbones should be...) */ +/* Err... bones should not be directly edited (only edit-bones should be...). */ static void rna_def_bone(BlenderRNA *brna) { StructRNA *srna; diff --git a/source/blender/makesrna/intern/rna_object.c b/source/blender/makesrna/intern/rna_object.c index 46a89d3a6e0..7f4ed39c001 100644 --- a/source/blender/makesrna/intern/rna_object.c +++ b/source/blender/makesrna/intern/rna_object.c @@ -407,7 +407,7 @@ static void rna_Object_matrix_local_set(PointerRNA *ptr, const float values[16]) Object *ob = (Object *)ptr->owner_id; float local_mat[4][4]; - /* Localspace matrix is truly relative to the parent, + /* Local-space matrix is truly relative to the parent, * but parameters stored in object are relative to parentinv matrix. * Undo the parent inverse part before applying it as local matrix. */ if (ob->parent) { diff --git a/source/blender/nodes/intern/node_exec.cc b/source/blender/nodes/intern/node_exec.cc index 724d6f1a1e1..af783ca391f 100644 --- a/source/blender/nodes/intern/node_exec.cc +++ b/source/blender/nodes/intern/node_exec.cc @@ -162,7 +162,7 @@ bNodeTreeExec *ntree_exec_begin(bNodeExecContext *context, /* XXX could let callbacks do this for specialized data */ exec = MEM_cnew<bNodeTreeExec>("node tree execution data"); - /* backpointer to node tree */ + /* Back-pointer to node tree. */ exec->nodetree = ntree; /* set stack indices */ diff --git a/source/blender/nodes/intern/node_exec.h b/source/blender/nodes/intern/node_exec.h index dc07f52e23f..55bf409444e 100644 --- a/source/blender/nodes/intern/node_exec.h +++ b/source/blender/nodes/intern/node_exec.h @@ -27,7 +27,7 @@ struct bNodeTree; /* Node execution data */ typedef struct bNodeExec { - /** Backpointer to node. */ + /** Back-pointer to node. */ struct bNode *node; bNodeExecData data; @@ -37,7 +37,7 @@ typedef struct bNodeExec { /* Execution Data for each instance of node tree execution */ typedef struct bNodeTreeExec { - struct bNodeTree *nodetree; /* backpointer to node tree */ + struct bNodeTree *nodetree; /* Back-pointer to node tree. */ int totnodes; /* total node count */ struct bNodeExec *nodeexec; /* per-node execution data */ diff --git a/source/blender/nodes/shader/node_shader_tree.cc b/source/blender/nodes/shader/node_shader_tree.cc index 52edf68b3ff..f177fc95ef8 100644 --- a/source/blender/nodes/shader/node_shader_tree.cc +++ b/source/blender/nodes/shader/node_shader_tree.cc @@ -1126,7 +1126,8 @@ void ntreeShaderEndExecTree(bNodeTreeExec *exec) bNodeTree *ntree = exec->nodetree; ntreeShaderEndExecTree_internal(exec); - /* XXX clear nodetree backpointer to exec data, same problem as noted in ntreeBeginExecTree */ + /* XXX: clear node-tree back-pointer to exec data, + * same problem as noted in #ntreeBeginExecTree. */ ntree->execdata = nullptr; } } diff --git a/source/blender/nodes/texture/node_texture_tree.c b/source/blender/nodes/texture/node_texture_tree.c index 81d0b0fbc84..99146f1a25c 100644 --- a/source/blender/nodes/texture/node_texture_tree.c +++ b/source/blender/nodes/texture/node_texture_tree.c @@ -308,7 +308,8 @@ void ntreeTexEndExecTree(bNodeTreeExec *exec) bNodeTree *ntree = exec->nodetree; ntreeTexEndExecTree_internal(exec); - /* XXX clear nodetree backpointer to exec data, same problem as noted in ntreeBeginExecTree */ + /* XXX: clear node-tree back-pointer to exec data, + * same problem as noted in #ntreeBeginExecTree. */ ntree->execdata = NULL; } } diff --git a/source/blender/python/intern/bpy_rna.c b/source/blender/python/intern/bpy_rna.c index 0eaa5d6b6c7..02f7e16e805 100644 --- a/source/blender/python/intern/bpy_rna.c +++ b/source/blender/python/intern/bpy_rna.c @@ -380,10 +380,10 @@ static short pyrna_rotation_euler_order_get(PointerRNA *ptr, const short order_fallback, PropertyRNA **r_prop_eul_order); -/* bpyrna vector/euler/quat callbacks. */ +/* `bpyrna` vector/euler/quaternion callbacks. */ static uchar mathutils_rna_array_cb_index = -1; /* Index for our callbacks. */ -/* Subtype not used much yet. */ +/* Sub-type not used much yet. */ # define MATHUTILS_CB_SUBTYPE_EUL 0 # define MATHUTILS_CB_SUBTYPE_VEC 1 # define MATHUTILS_CB_SUBTYPE_QUAT 2 diff --git a/source/blender/python/mathutils/mathutils_noise.c b/source/blender/python/mathutils/mathutils_noise.c index 3a3297f27f7..3c564142160 100644 --- a/source/blender/python/mathutils/mathutils_noise.c +++ b/source/blender/python/mathutils/mathutils_noise.c @@ -40,7 +40,7 @@ * * Any feedback is very welcome. * http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html - * email: m-mat @ math.sci.hiroshima-u.ac.jp (remove space). */ + * email: `m-mat @ math.sci.hiroshima-u.ac.jp` (remove space). */ /* Period parameters */ #define N 624 @@ -120,7 +120,7 @@ static void setRndSeed(int seed) } } -/* float number in range [0, 1) using the mersenne twister rng */ +/* Float number in range [0, 1) using the mersenne twister random number generator. */ static float frand(void) { ulong y; diff --git a/source/blender/render/intern/render_result.cc b/source/blender/render/intern/render_result.cc index f9524fdbf05..94f6e2f1509 100644 --- a/source/blender/render/intern/render_result.cc +++ b/source/blender/render/intern/render_result.cc @@ -262,7 +262,7 @@ RenderResult *render_result_new(Render *re, render_result_views_new(rr, &re->r); - /* check renderdata for amount of layers */ + /* Check render-data for amount of layers. */ FOREACH_VIEW_LAYER_TO_RENDER_BEGIN (re, view_layer) { if (layername && layername[0]) { if (!STREQ(view_layer->name, layername)) { diff --git a/source/blender/windowmanager/WM_types.h b/source/blender/windowmanager/WM_types.h index e25169109e7..e4050397aaa 100644 --- a/source/blender/windowmanager/WM_types.h +++ b/source/blender/windowmanager/WM_types.h @@ -359,7 +359,7 @@ typedef struct wmNotifier { /* data type, 256 entries is enough, it can overlap */ #define NOTE_DATA 0x00FF0000 -/* NC_WM windowmanager */ +/* NC_WM (window-manager). */ #define ND_FILEREAD (1 << 16) #define ND_FILESAVE (2 << 16) #define ND_DATACHANGED (3 << 16) diff --git a/source/blender/windowmanager/wm.h b/source/blender/windowmanager/wm.h index 0b54560c56a..0a27b9c1cfd 100644 --- a/source/blender/windowmanager/wm.h +++ b/source/blender/windowmanager/wm.h @@ -45,12 +45,12 @@ extern void wm_close_and_free_all(bContext *C, ListBase *); extern void wm_add_default(struct Main *bmain, bContext *C); extern void wm_clear_default_size(bContext *C); -/* register to windowmanager for redo or macro */ +/* Register to window-manager for redo or macro. */ /** * Called on event handling by `event_system.c`. * - * All operations get registered in the windowmanager here. + * All operations get registered in the window-manager here. */ void wm_operator_register(bContext *C, wmOperator *op); |