diff options
| author | Campbell Barton <campbell@blender.org> | 2022-09-16 11:13:19 +0300 |
|---|---|---|
| committer | Campbell Barton <campbell@blender.org> | 2022-09-16 11:14:33 +0300 |
| commit | 95f05a6a4ba66ed5533ad6d35ac92cdbe3aa0690 (patch) | |
| tree | 19f81181cb24c931c7e006822cf3fe2f39955866 /source/blender | |
| parent | 48d7ff68f0df209c77bbb081ab46fbc109fd825a (diff) | |
Cleanup: spelling in comments
Diffstat (limited to 'source/blender')
116 files changed, 201 insertions, 196 deletions
diff --git a/source/blender/blenfont/intern/blf_thumbs.c b/source/blender/blenfont/intern/blf_thumbs.c index bafa927a440..1670674ebba 100644 --- a/source/blender/blenfont/intern/blf_thumbs.c +++ b/source/blender/blenfont/intern/blf_thumbs.c @@ -94,7 +94,7 @@ void BLF_thumb_preview(const char *filepath, font->pos[1] -= (int)((float)blf_font_ascender(font) * 1.1f); - /* We fallback to default english strings in case not enough chars are available in current + /* We fallback to default English strings in case not enough chars are available in current * font for given translated string (useful in non-Latin i18n context, like Chinese, * since many fonts will then show nothing but ugly 'missing char' in their preview). * Does not handle all cases, but much better than nothing. diff --git a/source/blender/blenkernel/BKE_fcurve.h b/source/blender/blenkernel/BKE_fcurve.h index c5788c07336..c11e6353bc0 100644 --- a/source/blender/blenkernel/BKE_fcurve.h +++ b/source/blender/blenkernel/BKE_fcurve.h @@ -106,7 +106,7 @@ typedef enum eFMI_Action_Types { /* Flags for the requirements of a FModifier Type */ typedef enum eFMI_Requirement_Flags { - /* modifier requires original data-points (kindof beats the purpose of a modifier stack?) */ + /* modifier requires original data-points (kind of beats the purpose of a modifier stack?) */ FMI_REQUIRES_ORIGINAL_DATA = (1 << 0), /* modifier doesn't require on any preceding data (i.e. it will generate a curve). * Use in conjunction with FMI_TYPE_GENRATE_CURVE diff --git a/source/blender/blenkernel/BKE_global.h b/source/blender/blenkernel/BKE_global.h index 96b6f7a53b0..e28c87cd7d6 100644 --- a/source/blender/blenkernel/BKE_global.h +++ b/source/blender/blenkernel/BKE_global.h @@ -80,7 +80,7 @@ typedef struct Global { * * -1: Disable faster motion paths computation (since 08/2018). * * 1 - 30: EEVEE debug/stats values (01/2018). * * 31: Enable the Select Debug Engine. Only available with #WITH_DRAW_DEBUG (08/2021). - * * 101: Enable UI debug drawing of fullscreen area's corner widget (10/2014). + * * 101: Enable UI debug drawing of full-screen area's corner widget (10/2014). * * 102: Enable extra items in string search UI (05/2022). * * 666: Use quicker batch delete for outliners' delete hierarchy (01/2019). * * 777: Enable UI node panel's sockets polling (11/2011). diff --git a/source/blender/blenkernel/BKE_idprop.h b/source/blender/blenkernel/BKE_idprop.h index e9b075aeb49..9ac4b4e4619 100644 --- a/source/blender/blenkernel/BKE_idprop.h +++ b/source/blender/blenkernel/BKE_idprop.h @@ -328,7 +328,7 @@ typedef enum eIDPropertyUIDataType { IDP_UI_DATA_TYPE_UNSUPPORTED = -1, /** IDP_INT or IDP_ARRAY with subtype IDP_INT. */ IDP_UI_DATA_TYPE_INT = 0, - /** IDP_FLOAT and IDP_DOUBLE or IDP_ARRAY properties with a float or double subtypes. */ + /** IDP_FLOAT and IDP_DOUBLE or IDP_ARRAY properties with a float or double sub-types. */ IDP_UI_DATA_TYPE_FLOAT = 1, /** IDP_STRING properties. */ IDP_UI_DATA_TYPE_STRING = 2, diff --git a/source/blender/blenkernel/BKE_idprop.hh b/source/blender/blenkernel/BKE_idprop.hh index 6a42ab1669f..e8ac4119970 100644 --- a/source/blender/blenkernel/BKE_idprop.hh +++ b/source/blender/blenkernel/BKE_idprop.hh @@ -49,7 +49,7 @@ std::unique_ptr<IDProperty, IDPropertyDeleter> create(StringRefNull prop_name, std::unique_ptr<IDProperty, IDPropertyDeleter> create(StringRefNull prop_name, ID *id); /** - * \brief Allocate a new IDProperty of type IDP_ARRAY and subtype IDP_INT. + * \brief Allocate a new IDProperty of type IDP_ARRAY and sub-type IDP_INT. * * \param values: The values will be copied into the IDProperty. */ @@ -57,14 +57,14 @@ std::unique_ptr<IDProperty, IDPropertyDeleter> create(StringRefNull prop_name, Span<int32_t> values); /** - * \brief Allocate a new IDProperty of type IDP_ARRAY and subtype IDP_FLOAT. + * \brief Allocate a new IDProperty of type IDP_ARRAY and sub-type IDP_FLOAT. * * \param values: The values will be copied into the IDProperty. */ std::unique_ptr<IDProperty, IDPropertyDeleter> create(StringRefNull prop_name, Span<float> values); /** - * \brief Allocate a new IDProperty of type IDP_ARRAY and subtype IDP_DOUBLE. + * \brief Allocate a new IDProperty of type IDP_ARRAY and sub-type IDP_DOUBLE. * * \param values: The values will be copied into the IDProperty. */ diff --git a/source/blender/blenkernel/BKE_key.h b/source/blender/blenkernel/BKE_key.h index 45a72e8d7a3..0fe351c0aa4 100644 --- a/source/blender/blenkernel/BKE_key.h +++ b/source/blender/blenkernel/BKE_key.h @@ -22,7 +22,7 @@ extern "C" { #endif /** - * Free (or release) any data used by this shapekey (does not free the key itself). + * Free (or release) any data used by this shape-key (does not free the key itself). */ void BKE_key_free_data(struct Key *key); void BKE_key_free_nolib(struct Key *key); diff --git a/source/blender/blenkernel/BKE_lib_id.h b/source/blender/blenkernel/BKE_lib_id.h index e5b013ce201..86be68e5c64 100644 --- a/source/blender/blenkernel/BKE_lib_id.h +++ b/source/blender/blenkernel/BKE_lib_id.h @@ -117,14 +117,14 @@ void *BKE_id_new_nomain(short type, const char *name); */ enum { /* *** Generic options (should be handled by all ID types copying, ID creation, etc.). *** */ - /** Create datablock outside of any main database - + /** Create data-block outside of any main database - * similar to 'localize' functions of materials etc. */ LIB_ID_CREATE_NO_MAIN = 1 << 0, - /** Do not affect user refcount of datablocks used by new one - * (which also gets zero usercount then). + /** Do not affect user refcount of data-blocks used by new one + * (which also gets zero user-count then). * Implies LIB_ID_CREATE_NO_MAIN. */ LIB_ID_CREATE_NO_USER_REFCOUNT = 1 << 1, - /** Assume given 'newid' already points to allocated memory for whole datablock + /** Assume given 'newid' already points to allocated memory for whole data-block * (ID + data) - USE WITH CAUTION! * Implies LIB_ID_CREATE_NO_MAIN. */ LIB_ID_CREATE_NO_ALLOCATE = 1 << 2, @@ -239,12 +239,12 @@ enum { /** Do not try to remove freed ID from given Main (passed Main may be NULL). */ LIB_ID_FREE_NO_MAIN = 1 << 0, /** - * Do not affect user refcount of datablocks used by freed one. + * Do not affect user refcount of data-blocks used by freed one. * Implies LIB_ID_FREE_NO_MAIN. */ LIB_ID_FREE_NO_USER_REFCOUNT = 1 << 1, /** - * Assume freed ID datablock memory is managed elsewhere, do not free it + * Assume freed ID data-block memory is managed elsewhere, do not free it * (still calls relevant ID type's freeing function though) - USE WITH CAUTION! * Implies LIB_ID_FREE_NO_MAIN. */ @@ -254,7 +254,7 @@ enum { LIB_ID_FREE_NO_DEG_TAG = 1 << 8, /** Do not attempt to remove freed ID from UI data/notifiers/... */ LIB_ID_FREE_NO_UI_USER = 1 << 9, - /** Do not remove freed ID's name from a potential runtime namemap. */ + /** Do not remove freed ID's name from a potential runtime name-map. */ LIB_ID_FREE_NO_NAMEMAP_REMOVE = 1 << 10, }; @@ -283,7 +283,7 @@ void BKE_libblock_free_data_py(struct ID *id); * \param idv: Pointer to ID to be freed. * \param flag: Set of \a LIB_ID_FREE_... flags controlling/overriding usual freeing process, * 0 to get default safe behavior. - * \param use_flag_from_idtag: Still use freeing info flags from given #ID datablock, + * \param use_flag_from_idtag: Still use freeing info flags from given #ID data-block, * even if some overriding ones are passed in \a flag parameter. */ void BKE_id_free_ex(struct Main *bmain, void *idv, int flag, bool use_flag_from_idtag); @@ -300,7 +300,7 @@ void BKE_id_free(struct Main *bmain, void *idv); /** * Not really a freeing function by itself, - * it decrements usercount of given id, and only frees it if it reaches 0. + * it decrements user-count of given id, and only frees it if it reaches 0. */ void BKE_id_free_us(struct Main *bmain, void *idv) ATTR_NONNULL(); @@ -316,12 +316,12 @@ void BKE_id_delete(struct Main *bmain, void *idv) ATTR_NONNULL(); * * \warning Considered experimental for now, seems to be working OK but this is * risky code in a complicated area. - * \return Number of deleted datablocks. + * \return Number of deleted data-blocks. */ size_t BKE_id_multi_tagged_delete(struct Main *bmain) ATTR_NONNULL(); /** - * Add a 'NO_MAIN' data-block to given main (also sets usercounts of its IDs if needed). + * Add a 'NO_MAIN' data-block to given main (also sets user-counts of its IDs if needed). */ void BKE_libblock_management_main_add(struct Main *bmain, void *idv); /** Remove a data-block from given main (set it to 'NO_MAIN' status). */ diff --git a/source/blender/blenkernel/BKE_lib_remap.h b/source/blender/blenkernel/BKE_lib_remap.h index 37b626fb4da..a17ef8c7c5d 100644 --- a/source/blender/blenkernel/BKE_lib_remap.h +++ b/source/blender/blenkernel/BKE_lib_remap.h @@ -180,12 +180,12 @@ typedef enum IDRemapperApplyResult { typedef enum IDRemapperApplyOptions { /** - * Update the user count of the old and new ID datablock. + * Update the user count of the old and new ID data-block. * * For remapping the old ID users will be decremented and the new ID users will be * incremented. When un-assigning the old ID users will be decremented. * - * NOTE: Currently unused by main remapping code, since usercount is handled by + * NOTE: Currently unused by main remapping code, since user-count is handled by * `foreach_libblock_remap_callback_apply` there, depending on whether the remapped pointer does * use it or not. Need for rare cases in UI handling though (see e.g. `image_id_remap` in * `space_image.c`). @@ -193,14 +193,14 @@ typedef enum IDRemapperApplyOptions { ID_REMAP_APPLY_UPDATE_REFCOUNT = (1 << 0), /** - * Make sure that the new ID datablock will have a 'real' user. + * Make sure that the new ID data-block will have a 'real' user. * * NOTE: See Note for #ID_REMAP_APPLY_UPDATE_REFCOUNT above. */ ID_REMAP_APPLY_ENSURE_REAL = (1 << 1), /** - * Unassign in stead of remap when the new ID datablock would become id_self. + * Unassign in stead of remap when the new ID data-block would become id_self. * * To use this option 'BKE_id_remapper_apply_ex' must be used with a not-null id_self parameter. */ diff --git a/source/blender/blenkernel/BKE_screen.h b/source/blender/blenkernel/BKE_screen.h index 3691ab677b7..62b04785983 100644 --- a/source/blender/blenkernel/BKE_screen.h +++ b/source/blender/blenkernel/BKE_screen.h @@ -113,7 +113,7 @@ typedef struct SpaceType { /* read and write... */ - /* default keymaps to add */ + /** Default key-maps to add. */ int keymapflag; } SpaceType; diff --git a/source/blender/blenkernel/intern/DerivedMesh.cc b/source/blender/blenkernel/intern/DerivedMesh.cc index 9c05a2c4061..3aeb2a17b3c 100644 --- a/source/blender/blenkernel/intern/DerivedMesh.cc +++ b/source/blender/blenkernel/intern/DerivedMesh.cc @@ -188,7 +188,7 @@ void DM_init_funcs(DerivedMesh *dm) dm->getLoopTriArray = dm_getLoopTriArray; - /* subtypes handle getting actual data */ + /* Sub-types handle getting actual data. */ dm->getNumLoopTri = dm_getNumLoopTri; dm->getVertDataArray = DM_get_vert_data_layer; diff --git a/source/blender/blenkernel/intern/action.c b/source/blender/blenkernel/intern/action.c index e0ae1d88760..10aa4ec7906 100644 --- a/source/blender/blenkernel/intern/action.c +++ b/source/blender/blenkernel/intern/action.c @@ -113,7 +113,7 @@ static void action_copy_data(Main *UNUSED(bmain), ID *id_dst, const ID *id_src, BLI_addtail(&action_dst->curves, fcurve_dst); - /* Fix group links (kindof bad list-in-list search, but this is the most reliable way). */ + /* Fix group links (kind of bad list-in-list search, but this is the most reliable way). */ for (group_dst = action_dst->groups.first, group_src = action_src->groups.first; group_dst && group_src; group_dst = group_dst->next, group_src = group_src->next) { diff --git a/source/blender/blenkernel/intern/anim_data.c b/source/blender/blenkernel/intern/anim_data.c index b5b00e031b2..65ce3e3b523 100644 --- a/source/blender/blenkernel/intern/anim_data.c +++ b/source/blender/blenkernel/intern/anim_data.c @@ -136,7 +136,7 @@ bool BKE_animdata_set_action(ReportList *reports, ID *id, bAction *act) return false; } - /* Reduce usercount for current action. */ + /* Reduce user-count for current action. */ if (adt->action) { id_us_min((ID *)adt->action); } @@ -287,11 +287,11 @@ AnimData *BKE_animdata_copy(Main *bmain, AnimData *adt, const int flag) /* make a copy of action - at worst, user has to delete copies... */ if (do_action) { - /* Recursive copy of 'real' IDs is a bit hairy. Even if do not want to deal with usercount - * when copying ID's data itself, we still need to do so with sub-IDs, since those will not be - * handled by later 'update usercounts of used IDs' code as used e.g. at end of - * BKE_id_copy_ex(). - * So in case we do copy the ID and its sub-IDs in bmain, silence the 'no usercount' flag for + /* Recursive copy of 'real' IDs is a bit hairy. Even if do not want to deal with user-count + * when copying ID's data itself, we still need to do so with sub-IDs, since those will not be + * handled by later 'update user-counts of used IDs' code as used e.g. at end of + * #BKE_id_copy_ex(). + * So in case we do copy the ID and its sub-IDs in bmain, silence the 'no user-count' flag for * the sub-IDs copying. * NOTE: This is a bit weak, as usually when it comes to recursive ID copy. Should work for * now, but we may have to revisit this at some point and add a proper extra flag to deal with diff --git a/source/blender/blenkernel/intern/armature.c b/source/blender/blenkernel/intern/armature.c index 0027f6dd707..9b00d427320 100644 --- a/source/blender/blenkernel/intern/armature.c +++ b/source/blender/blenkernel/intern/armature.c @@ -97,7 +97,7 @@ static void armature_copy_data(Main *UNUSED(bmain), ID *id_dst, const ID *id_src Bone *bone_src, *bone_dst; Bone *bone_dst_act = NULL; - /* We never handle usercount here for own data. */ + /* We never handle user-count here for own data. */ const int flag_subdata = flag | LIB_ID_CREATE_NO_USER_REFCOUNT; armature_dst->bonehash = NULL; diff --git a/source/blender/blenkernel/intern/camera.c b/source/blender/blenkernel/intern/camera.c index 158e0bb776c..8384e94e6d5 100644 --- a/source/blender/blenkernel/intern/camera.c +++ b/source/blender/blenkernel/intern/camera.c @@ -72,7 +72,7 @@ static void camera_copy_data(Main *UNUSED(bmain), ID *id_dst, const ID *id_src, Camera *cam_dst = (Camera *)id_dst; const Camera *cam_src = (const Camera *)id_src; - /* We never handle usercount here for own data. */ + /* We never handle user-count here for own data. */ const int flag_subdata = flag | LIB_ID_CREATE_NO_USER_REFCOUNT; BLI_listbase_clear(&cam_dst->bg_images); diff --git a/source/blender/blenkernel/intern/constraint.c b/source/blender/blenkernel/intern/constraint.c index bcc3db48947..0b07d2f979f 100644 --- a/source/blender/blenkernel/intern/constraint.c +++ b/source/blender/blenkernel/intern/constraint.c @@ -5932,12 +5932,12 @@ static void constraint_copy_data_ex(bConstraint *dst, cti->copy_data(dst, src); } - /* Fix usercounts for all referenced data that need it. */ + /* Fix user-counts for all referenced data that need it. */ if ((flag & LIB_ID_CREATE_NO_USER_REFCOUNT) == 0) { con_invoke_id_looper(cti, dst, con_fix_copied_refs_cb, NULL); } - /* for proxies we don't want to make extern */ + /* For proxies we don't want to make external. */ if (do_extern) { /* go over used ID-links for this constraint to ensure that they are valid for proxies */ con_invoke_id_looper(cti, dst, con_extern_cb, NULL); diff --git a/source/blender/blenkernel/intern/idprop_create.cc b/source/blender/blenkernel/intern/idprop_create.cc index 24f59d5e49e..8a6e5cdcc50 100644 --- a/source/blender/blenkernel/intern/idprop_create.cc +++ b/source/blender/blenkernel/intern/idprop_create.cc @@ -79,7 +79,7 @@ static void array_values_set(IDProperty *property, template< /** C-Primitive type of the array. Can be int32_t, float, double. */ typename PrimitiveType, - /** Subtype of the ID_ARRAY. Must match PrimitiveType. */ + /** Sub-type of the #ID_ARRAY. Must match #PrimitiveType. */ eIDPropertyType id_property_subtype> std::unique_ptr<IDProperty, IDPropertyDeleter> create_array(StringRefNull prop_name, Span<PrimitiveType> values) diff --git a/source/blender/blenkernel/intern/image.cc b/source/blender/blenkernel/intern/image.cc index 75cf10f88aa..44e0e7be97b 100644 --- a/source/blender/blenkernel/intern/image.cc +++ b/source/blender/blenkernel/intern/image.cc @@ -2662,7 +2662,7 @@ Image *BKE_image_ensure_viewer(Main *bmain, int type, const char *name) ima = image_alloc(bmain, name, IMA_SRC_VIEWER, type); } - /* Happens on reload, imagewindow cannot be image user when hidden. */ + /* Happens on reload, image-window cannot be image user when hidden. */ if (ima->id.us == 0) { id_us_ensure_real(&ima->id); } diff --git a/source/blender/blenkernel/intern/ipo.c b/source/blender/blenkernel/intern/ipo.c index 22c0007cbc0..40a5c08a068 100644 --- a/source/blender/blenkernel/intern/ipo.c +++ b/source/blender/blenkernel/intern/ipo.c @@ -2142,7 +2142,7 @@ void do_versions_ipos_to_animato(Main *bmain) if (ob->action) { action_to_animdata(id, ob->action); - /* only decrease usercount if this Action isn't now being used by AnimData */ + /* Only decrease user-count if this Action isn't now being used by AnimData. */ if (ob->action != adt->action) { id_us_min(&ob->action->id); ob->action = NULL; @@ -2246,7 +2246,7 @@ void do_versions_ipos_to_animato(Main *bmain) /* Add AnimData block */ AnimData *adt = BKE_animdata_ensure_id(id); - /* Convert Shapekey data... */ + /* Convert Shape-key data... */ ipo_to_animdata(bmain, id, key->ipo, NULL, NULL, NULL); if (adt->action) { diff --git a/source/blender/blenkernel/intern/lib_id.c b/source/blender/blenkernel/intern/lib_id.c index 8faa260ab8b..158aaa961ce 100644 --- a/source/blender/blenkernel/intern/lib_id.c +++ b/source/blender/blenkernel/intern/lib_id.c @@ -416,7 +416,7 @@ static int lib_id_expand_local_cb(LibraryIDLinkCallbackData *cb_data) /* Can happen that we get un-linkable ID here, e.g. with shape-key referring to itself * (through drivers)... * Just skip it, shape key can only be either indirectly linked, or fully local, period. - * And let's curse one more time that stupid useless shapekey ID type! */ + * And let's curse one more time that stupid useless shape-key ID type! */ if (*id_pointer && *id_pointer != id_self && BKE_idtype_idcode_is_linkable(GS((*id_pointer)->name))) { id_lib_extern(*id_pointer); @@ -566,7 +566,7 @@ struct IDCopyLibManagementData { int flag; }; -/* Increases usercount as required, and remap self ID pointers. */ +/** Increases user-count as required, and remap self ID pointers. */ static int id_copy_libmanagement_cb(LibraryIDLinkCallbackData *cb_data) { ID **id_pointer = cb_data->id_pointer; @@ -1289,7 +1289,7 @@ void BKE_libblock_copy_ex(Main *bmain, const ID *id, ID **r_newid, const int ori new_id->flag = (new_id->flag & ~copy_idflag_mask) | (id->flag & copy_idflag_mask); - /* We do not want any handling of usercount in code duplicating the data here, we do that all + /* We do not want any handling of user-count in code duplicating the data here, we do that all * at once in id_copy_libmanagement_cb() at the end. */ const int copy_data_flag = orig_flag | LIB_ID_CREATE_NO_USER_REFCOUNT; @@ -1566,7 +1566,7 @@ void BKE_main_id_refcount_recompute(struct Main *bmain, const bool do_linked_onl } FOREACH_MAIN_ID_END; - /* Go over whole Main database to re-generate proper usercounts... */ + /* Go over whole Main database to re-generate proper user-counts. */ FOREACH_MAIN_ID_BEGIN (bmain, id) { BKE_library_foreach_ID_link(bmain, id, diff --git a/source/blender/blenkernel/intern/lib_id_delete.c b/source/blender/blenkernel/intern/lib_id_delete.c index 8d5699d7d49..f4f5ca7a1d7 100644 --- a/source/blender/blenkernel/intern/lib_id_delete.c +++ b/source/blender/blenkernel/intern/lib_id_delete.c @@ -280,8 +280,8 @@ static size_t id_delete(Main *bmain, const bool do_tagged_deletion) } /* Now we can safely mark that ID as not being in Main database anymore. */ - /* NOTE: This needs to be done in a separate loop than above, otherwise some usercounts of - * deleted IDs may not be properly decreased by the remappings (since `NO_MAIN` ID usercounts + /* NOTE: This needs to be done in a separate loop than above, otherwise some user-counts of + * deleted IDs may not be properly decreased by the remappings (since `NO_MAIN` ID user-counts * is never affected). */ for (ID *id = tagged_deleted_ids.first; id; id = id->next) { id->tag |= LIB_TAG_NO_MAIN; diff --git a/source/blender/blenkernel/intern/lib_override.cc b/source/blender/blenkernel/intern/lib_override.cc index b05ae775be6..3f1b80014ac 100644 --- a/source/blender/blenkernel/intern/lib_override.cc +++ b/source/blender/blenkernel/intern/lib_override.cc @@ -1846,8 +1846,8 @@ static bool lib_override_library_resync(Main *bmain, } } if (reference_id == nullptr) { - /* Can happen e.g. when there is a local override of a shapekey, but the matching linked - * obdata (mesh etc.) does not have any shapekey anymore. */ + /* Can happen e.g. when there is a local override of a shape-key, but the matching linked + * obdata (mesh etc.) does not have any shape-key anymore. */ continue; } BLI_assert(GS(reference_id->name) == GS(id->name)); @@ -3951,7 +3951,7 @@ void BKE_lib_override_library_operations_store_end( void BKE_lib_override_library_operations_store_finalize(OverrideLibraryStorage *override_storage) { /* We cannot just call BKE_main_free(override_storage), not until we have option to make - * 'ghost' copies of IDs without increasing usercount of used data-blocks. */ + * 'ghost' copies of IDs without increasing user-count of used data-blocks. */ ID *id; FOREACH_MAIN_ID_BEGIN (override_storage, id) { diff --git a/source/blender/blenkernel/intern/mask.c b/source/blender/blenkernel/intern/mask.c index 25268785d42..0b8351efdf4 100644 --- a/source/blender/blenkernel/intern/mask.c +++ b/source/blender/blenkernel/intern/mask.c @@ -1579,7 +1579,7 @@ void BKE_mask_parent_init(MaskParent *parent) parent->id_type = ID_MC; } -/* *** own animation/shapekey implementation *** +/* *** own animation/shape-key implementation *** * BKE_mask_layer_shape_XXX */ int BKE_mask_layer_shape_totvert(MaskLayer *masklay) diff --git a/source/blender/blenkernel/intern/nla.c b/source/blender/blenkernel/intern/nla.c index da508ff865c..c0315dcc848 100644 --- a/source/blender/blenkernel/intern/nla.c +++ b/source/blender/blenkernel/intern/nla.c @@ -2072,7 +2072,7 @@ bool BKE_nla_tweakmode_enter(AnimData *adt) /* handle AnimData level changes: * - 'real' active action to temp storage (no need to change user-counts). - * - Action of active strip set to be the 'active action', and have its usercount incremented. + * - Action of active strip set to be the 'active action', and have its user-count incremented. * - Editing-flag for this AnimData block should also get turned on * (for more efficient restoring). * - Take note of the active strip for mapping-correction of keyframes @@ -2136,7 +2136,8 @@ void BKE_nla_tweakmode_exit(AnimData *adt) } /* handle AnimData level changes: - * - 'temporary' active action needs its usercount decreased, since we're removing this reference + * - 'temporary' active action needs its user-count decreased, + * since we're removing this reference * - 'real' active action is restored from storage * - storage pointer gets cleared (to avoid having bad notes hanging around) * - editing-flag for this AnimData block should also get turned off diff --git a/source/blender/blenkernel/intern/node.cc b/source/blender/blenkernel/intern/node.cc index b82cf30416a..c462d03e3da 100644 --- a/source/blender/blenkernel/intern/node.cc +++ b/source/blender/blenkernel/intern/node.cc @@ -132,7 +132,7 @@ static void ntree_copy_data(Main *UNUSED(bmain), ID *id_dst, const ID *id_src, c bNodeTree *ntree_dst = (bNodeTree *)id_dst; const bNodeTree *ntree_src = (const bNodeTree *)id_src; - /* We never handle usercount here for own data. */ + /* We never handle user-count here for own data. */ const int flag_subdata = flag | LIB_ID_CREATE_NO_USER_REFCOUNT; ntree_dst->runtime = MEM_new<bNodeTreeRuntime>(__func__); diff --git a/source/blender/blenkernel/intern/object.cc b/source/blender/blenkernel/intern/object.cc index cbe5ea425fb..0b58d063b8e 100644 --- a/source/blender/blenkernel/intern/object.cc +++ b/source/blender/blenkernel/intern/object.cc @@ -188,7 +188,7 @@ static void object_copy_data(Main *bmain, ID *id_dst, const ID *id_src, const in /* Do not copy runtime data. */ BKE_object_runtime_reset_on_copy(ob_dst, flag); - /* We never handle usercount here for own data. */ + /* We never handle user-count here for own data. */ const int flag_subdata = flag | LIB_ID_CREATE_NO_USER_REFCOUNT; if (ob_src->totcol) { diff --git a/source/blender/blenkernel/intern/rigidbody.c b/source/blender/blenkernel/intern/rigidbody.c index 6adb728b515..2705241425b 100644 --- a/source/blender/blenkernel/intern/rigidbody.c +++ b/source/blender/blenkernel/intern/rigidbody.c @@ -1545,7 +1545,7 @@ void BKE_rigidbody_remove_object(Main *bmain, Scene *scene, Object *ob, const bo FOREACH_COLLECTION_OBJECT_RECURSIVE_END; } - /* Relying on usercount of the object should be OK, and it is much cheaper than looping in all + /* Relying on user-count of the object should be OK, and it is much cheaper than looping in all * collections to check whether the object is already in another one... */ if (ID_REAL_USERS(&ob->id) == 1) { /* Some users seems to find it funny to use a view-layer instancing collection diff --git a/source/blender/blenkernel/intern/scene.cc b/source/blender/blenkernel/intern/scene.cc index db950492f69..9c0e5a5534e 100644 --- a/source/blender/blenkernel/intern/scene.cc +++ b/source/blender/blenkernel/intern/scene.cc @@ -235,7 +235,7 @@ static void scene_copy_data(Main *bmain, ID *id_dst, const ID *id_src, const int { Scene *scene_dst = (Scene *)id_dst; const Scene *scene_src = (const Scene *)id_src; - /* We never handle usercount here for own data. */ + /* We never handle user-count here for own data. */ const int flag_subdata = flag | LIB_ID_CREATE_NO_USER_REFCOUNT; /* We always need allocation of our private ID data. */ const int flag_private_id_data = flag & ~LIB_ID_CREATE_NO_ALLOCATE; diff --git a/source/blender/blenkernel/intern/screen.c b/source/blender/blenkernel/intern/screen.c index 40348824a13..cefc577d1f1 100644 --- a/source/blender/blenkernel/intern/screen.c +++ b/source/blender/blenkernel/intern/screen.c @@ -305,7 +305,7 @@ IDTypeInfo IDType_ID_SCR = { .lib_override_apply_post = NULL, }; -/* ************ Spacetype/regiontype handling ************** */ +/* ************ Space-type/region-type handling ************** */ /* keep global; this has to be accessible outside of windowmanager */ static ListBase spacetypes = {NULL, NULL}; diff --git a/source/blender/blenkernel/intern/vfont.c b/source/blender/blenkernel/intern/vfont.c index 288493c9d65..ddc758c6887 100644 --- a/source/blender/blenkernel/intern/vfont.c +++ b/source/blender/blenkernel/intern/vfont.c @@ -81,7 +81,7 @@ static void vfont_copy_data(Main *UNUSED(bmain), { VFont *vfont_dst = (VFont *)id_dst; - /* We never handle usercount here for own data. */ + /* We never handle user-count here for own data. */ const int flag_subdata = flag | LIB_ID_CREATE_NO_USER_REFCOUNT; /* Just to be sure, should not have any value actually after reading time. */ diff --git a/source/blender/blenlib/BLI_path_util.h b/source/blender/blenlib/BLI_path_util.h index 136258e50f2..5ae2de99d8f 100644 --- a/source/blender/blenlib/BLI_path_util.h +++ b/source/blender/blenlib/BLI_path_util.h @@ -365,8 +365,8 @@ void BLI_path_normalize_unc(char *path_16, int maxlen); /** * Appends a suffix to the string, fitting it before the extension * - * string = Foo.png, suffix = 123, separator = _ - * Foo.png -> Foo_123.png + * string = `Foo.png`, suffix = `123`, separator = `_`. + * `Foo.png` -> `Foo_123.png`. * * \param string: original (and final) string * \param maxlen: Maximum length of string diff --git a/source/blender/blenloader/intern/readfile.cc b/source/blender/blenloader/intern/readfile.cc index 17c462825c7..71708c09c01 100644 --- a/source/blender/blenloader/intern/readfile.cc +++ b/source/blender/blenloader/intern/readfile.cc @@ -2441,7 +2441,7 @@ static int lib_link_main_data_restore_cb(LibraryIDLinkCallbackData *cb_data) struct IDNameLib_Map *id_map = static_cast<IDNameLib_Map *>(cb_data->user_data); - /* NOTE: Handling of usercount here is really bad, defining its own system... + /* NOTE: Handling of user-count here is really bad, defining its own system... * Will have to be refactored at some point, but that is not top priority task for now. * And all user-counts are properly recomputed at the end of the undo management code anyway. */ *id_pointer = static_cast<ID *>(restore_pointer_by_name( @@ -4777,7 +4777,7 @@ static void read_library_linked_ids(FileData *basefd, } /* `realid` shall never be nullptr - unless some source file/lib is broken - * (known case: some directly linked shapekey from a missing lib...). */ + * (known case: some directly linked shape-key from a missing lib...). */ // BLI_assert(*realid != nullptr); /* Now that we have a real ID, replace all pointers to placeholders in diff --git a/source/blender/blenloader/intern/writefile.cc b/source/blender/blenloader/intern/writefile.cc index 5f326a68018..6b7c4489eee 100644 --- a/source/blender/blenloader/intern/writefile.cc +++ b/source/blender/blenloader/intern/writefile.cc @@ -1161,7 +1161,7 @@ static bool write_file_handle(Main *mainvar, /* We only write unused IDs in undo case. * NOTE: All Scenes, WindowManagers and WorkSpaces should always be written to disk, so - * their usercount should never be nullptr currently. */ + * their user-count should never be nullptr currently. */ if (id->us == 0 && !wd->use_memfile) { BLI_assert(!ELEM(GS(id->name), ID_SCE, ID_WM, ID_WS)); continue; @@ -1176,7 +1176,7 @@ static bool write_file_handle(Main *mainvar, if (wd->use_memfile) { /* Record the changes that happened up to this undo push in - * recalc_up_to_undo_push, and clear recalc_after_undo_push again + * recalc_up_to_undo_push, and clear `recalc_after_undo_push` again * to start accumulating for the next undo push. */ id->recalc_up_to_undo_push = id->recalc_after_undo_push; id->recalc_after_undo_push = 0; diff --git a/source/blender/blentranslation/BLT_translation.h b/source/blender/blentranslation/BLT_translation.h index 129eba3de2f..a4554c4e0bd 100644 --- a/source/blender/blentranslation/BLT_translation.h +++ b/source/blender/blentranslation/BLT_translation.h @@ -74,7 +74,7 @@ const char *BLT_translate_do_new_dataname(const char *msgctxt, const char *msgid #define BLT_I18NCONTEXT_UI_EVENTS "UI_Events_KeyMaps" /* Mark the msgid applies to several elements - * (needed in some cases, as english adjectives have no plural mark :( ). */ + * (needed in some cases, as English adjectives have no plural mark :( ). */ #define BLT_I18NCONTEXT_PLURAL "Plural" /* ID-types contexts. */ diff --git a/source/blender/bmesh/bmesh.h b/source/blender/bmesh/bmesh.h index 2833105e5a4..3956db0288a 100644 --- a/source/blender/bmesh/bmesh.h +++ b/source/blender/bmesh/bmesh.h @@ -148,7 +148,7 @@ * * These conventions should be used throughout the bmesh module. * - * - `bmesh_kernel_*()` - Low level API, for primitive functions that others are built ontop of. + * - `bmesh_kernel_*()` - Low level API, for primitive functions that others are built on top of. * - `bmesh_***()` - Low level API function. * - `bm_***()` - 'static' functions, not a part of the API at all, * but use prefix since they operate on BMesh data. diff --git a/source/blender/bmesh/intern/bmesh_core.c b/source/blender/bmesh/intern/bmesh_core.c index 4d84d558cd7..5fbbd087d7e 100644 --- a/source/blender/bmesh/intern/bmesh_core.c +++ b/source/blender/bmesh/intern/bmesh_core.c @@ -95,7 +95,7 @@ BMVert *BM_vert_create(BMesh *bm, /* handles 'v->no' too */ BM_elem_attrs_copy(bm, bm, v_example, v); - /* exception: don't copy the original shapekey index */ + /* Exception: don't copy the original shape-key index. */ keyi = CustomData_bmesh_get(&bm->vdata, v->head.data, CD_SHAPE_KEYINDEX); if (keyi) { *keyi = ORIGINDEX_NONE; diff --git a/source/blender/bmesh/operators/bmo_subdivide.c b/source/blender/bmesh/operators/bmo_subdivide.c index d6c64809e13..b6cd4dc8777 100644 --- a/source/blender/bmesh/operators/bmo_subdivide.c +++ b/source/blender/bmesh/operators/bmo_subdivide.c @@ -966,7 +966,7 @@ void bmo_subdivide_edges_exec(BMesh *bm, BMOperator *op) patterns[5] = NULL; } - /* add a temporary shapekey layer to store displacements on current geometry */ + /* Add a temporary shape-key layer to store displacements on current geometry. */ BM_data_layer_add(bm, &bm->vdata, CD_SHAPEKEY); bmo_subd_init_shape_info(bm, ¶ms); diff --git a/source/blender/compositor/operations/COM_TonemapOperation.h b/source/blender/compositor/operations/COM_TonemapOperation.h index 8071470b3f4..4e68d432985 100644 --- a/source/blender/compositor/operations/COM_TonemapOperation.h +++ b/source/blender/compositor/operations/COM_TonemapOperation.h @@ -21,7 +21,7 @@ typedef struct AvgLogLum { } AvgLogLum; /** - * \brief base class of tonemap, implementing the simple tonemap + * \brief base class of tone-map, implementing the simple tone-map * \ingroup operation */ class TonemapOperation : public MultiThreadedOperation { @@ -32,7 +32,7 @@ class TonemapOperation : public MultiThreadedOperation { SocketReader *image_reader_; /** - * \brief settings of the Tonemap + * \brief settings of the Tone-map */ const NodeTonemap *data_; diff --git a/source/blender/draw/engines/eevee/eevee_private.h b/source/blender/draw/engines/eevee/eevee_private.h index 573c29b78a1..94a0154055c 100644 --- a/source/blender/draw/engines/eevee/eevee_private.h +++ b/source/blender/draw/engines/eevee/eevee_private.h @@ -815,7 +815,7 @@ typedef struct EEVEE_EffectsInfo { struct GPUTexture *dof_reduce_input_color_tx; /* Other */ float prev_persmat[4][4]; - /* Size used by all fullscreen buffers using mipmaps. */ + /* Size used by all full-screen buffers using mipmaps. */ int hiz_size[2]; /* Lookdev */ int sphere_size; diff --git a/source/blender/draw/engines/eevee_next/eevee_film.cc b/source/blender/draw/engines/eevee_next/eevee_film.cc index b89746d99e2..244eb1e54ef 100644 --- a/source/blender/draw/engines/eevee_next/eevee_film.cc +++ b/source/blender/draw/engines/eevee_next/eevee_film.cc @@ -5,7 +5,7 @@ /** \file * \ingroup eevee * - * A film is a fullscreen buffer (usually at output extent) + * A film is a full-screen buffer (usually at output extent) * that will be able to accumulate sample in any distorted camera_type * using a pixel filter. * diff --git a/source/blender/draw/engines/eevee_next/eevee_renderbuffers.cc b/source/blender/draw/engines/eevee_next/eevee_renderbuffers.cc index 8e36e1d071c..f5638cc5160 100644 --- a/source/blender/draw/engines/eevee_next/eevee_renderbuffers.cc +++ b/source/blender/draw/engines/eevee_next/eevee_renderbuffers.cc @@ -5,7 +5,7 @@ /** \file * \ingroup eevee * - * A film is a fullscreen buffer (usually at output extent) + * A film is a full-screen buffer (usually at output extent) * that will be able to accumulate sample in any distorted camera_type * using a pixel filter. * diff --git a/source/blender/draw/engines/gpencil/shaders/infos/gpencil_info.hh b/source/blender/draw/engines/gpencil/shaders/infos/gpencil_info.hh index 1db98d13c4a..ee22362e0d4 100644 --- a/source/blender/draw/engines/gpencil/shaders/infos/gpencil_info.hh +++ b/source/blender/draw/engines/gpencil/shaders/infos/gpencil_info.hh @@ -47,7 +47,7 @@ GPU_SHADER_CREATE_INFO(gpencil_geometry) /** \} */ /* -------------------------------------------------------------------- */ -/** \name Fullscreen shaders +/** \name Full-Screen Shaders * \{ */ GPU_SHADER_CREATE_INFO(gpencil_layer_blend) diff --git a/source/blender/editors/animation/anim_channels_defines.c b/source/blender/editors/animation/anim_channels_defines.c index b7562073ee7..8edeea49cbb 100644 --- a/source/blender/editors/animation/anim_channels_defines.c +++ b/source/blender/editors/animation/anim_channels_defines.c @@ -5353,8 +5353,8 @@ void ANIM_channel_draw_widgets(const bContext *C, * and wouldn't be able to auto-keyframe. * - Slider should start before the toggles (if they're visible) * to keep a clean line down the side. - * - Sliders are always drawn in Shapekey mode now. Prior to this - * the SACTION_SLIDERS flag would be set when changing into Shapekey mode. + * - Sliders are always drawn in Shape-key mode now. Prior to this + * the SACTION_SLIDERS flag would be set when changing into shape-key mode. */ if (((draw_sliders) && ELEM(ale->type, ANIMTYPE_FCURVE, diff --git a/source/blender/editors/animation/keyingsets.c b/source/blender/editors/animation/keyingsets.c index e6bcb404bcb..97e90af019b 100644 --- a/source/blender/editors/animation/keyingsets.c +++ b/source/blender/editors/animation/keyingsets.c @@ -589,7 +589,7 @@ void ANIM_keyingset_info_unregister(Main *bmain, KeyingSetInfo *ksi) /* find relevant builtin KeyingSets which use this, and remove them */ /* TODO: this isn't done now, since unregister is really only used at the moment when we - * reload the scripts, which kindof defeats the purpose of "builtin"? */ + * reload the scripts, which kind of defeats the purpose of "builtin"? */ for (ks = builtin_keyingsets.first; ks; ks = ksn) { ksn = ks->next; diff --git a/source/blender/editors/armature/pose_transform.c b/source/blender/editors/armature/pose_transform.c index 4211dd78b88..2a23615caa3 100644 --- a/source/blender/editors/armature/pose_transform.c +++ b/source/blender/editors/armature/pose_transform.c @@ -1116,7 +1116,7 @@ static void pchan_clear_rot(bPoseChannel *pchan) } /* Clear also Bendy Bone stuff - Roll is obvious, - * but Curve X/Y stuff is also kindof rotational in nature... */ + * but Curve X/Y stuff is also kind of rotational in nature... */ pchan->roll1 = 0.0f; pchan->roll2 = 0.0f; diff --git a/source/blender/editors/curve/editcurve.c b/source/blender/editors/curve/editcurve.c index 46634674c34..5e810d93115 100644 --- a/source/blender/editors/curve/editcurve.c +++ b/source/blender/editors/curve/editcurve.c @@ -1254,7 +1254,7 @@ void ED_curve_editnurb_load(Main *bmain, Object *obedit) } /* We have to pass also new copied nurbs, since we want to restore original curve - * (without edited shapekey) on obdata, but *not* on editcurve itself + * (without edited shape-key) on obdata, but *not* on editcurve itself * (ED_curve_editnurb_load call does not always implies freeing * of editcurve, e.g. when called to generate render data). */ calc_shapeKeys(obedit, &newnurb); @@ -1298,15 +1298,15 @@ void ED_curve_editnurb_make(Object *obedit) BLI_addtail(&editnurb->nurbs, newnu); } - /* animation could be added in editmode even if there was no animdata in - * object mode hence we always need CVs index be created */ + /* Animation could be added in edit-mode even if there was no animdata in + * object mode hence we always need CVs index be created. */ init_editNurb_keyIndex(editnurb, &cu->nurb); if (actkey) { editnurb->shapenr = obedit->shapenr; - /* Apply shapekey to new nurbs of editnurb, not those of original curve + /* Apply shape-key to new nurbs of editnurb, not those of original curve * (and *after* we generated keyIndex), else we do not have valid 'original' data - * to properly restore curve when leaving editmode. */ + * to properly restore curve when leaving edit-mode. */ BKE_keyblock_convert_to_curve(actkey, cu, &editnurb->nurbs); } } diff --git a/source/blender/editors/curve/editcurve_pen.c b/source/blender/editors/curve/editcurve_pen.c index 27f4e4fca61..395053d6b1b 100644 --- a/source/blender/editors/curve/editcurve_pen.c +++ b/source/blender/editors/curve/editcurve_pen.c @@ -1532,7 +1532,7 @@ wmKeyMap *curve_pen_modal_keymap(wmKeyConfig *keyconf) wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "Curve Pen Modal Map"); - /* This function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return NULL; } diff --git a/source/blender/editors/gpencil/annotate_paint.c b/source/blender/editors/gpencil/annotate_paint.c index 287dce1a509..ea34e6530fa 100644 --- a/source/blender/editors/gpencil/annotate_paint.c +++ b/source/blender/editors/gpencil/annotate_paint.c @@ -2346,7 +2346,7 @@ static int annotation_draw_invoke(bContext *C, wmOperator *op, const wmEvent *ev return OPERATOR_RUNNING_MODAL; } -/* gpencil modal operator stores area, which can be removed while using it (like fullscreen) */ +/* gpencil modal operator stores area, which can be removed while using it (like full-screen). */ static bool annotation_area_exists(bContext *C, ScrArea *area_test) { bScreen *screen = CTX_wm_screen(C); @@ -2698,7 +2698,7 @@ static int annotation_draw_modal(bContext *C, wmOperator *op, const wmEvent *eve } } - /* gpencil modal operator stores area, which can be removed while using it (like fullscreen) */ + /* gpencil modal operator stores area, which can be removed while using it (like full-screen). */ if (0 == annotation_area_exists(C, p->area)) { estate = OPERATOR_CANCELLED; } diff --git a/source/blender/editors/gpencil/gpencil_paint.c b/source/blender/editors/gpencil/gpencil_paint.c index 8e33a029229..7446c727a0c 100644 --- a/source/blender/editors/gpencil/gpencil_paint.c +++ b/source/blender/editors/gpencil/gpencil_paint.c @@ -3331,7 +3331,7 @@ static int gpencil_draw_invoke(bContext *C, wmOperator *op, const wmEvent *event return OPERATOR_RUNNING_MODAL; } -/* gpencil modal operator stores area, which can be removed while using it (like fullscreen) */ +/* gpencil modal operator stores area, which can be removed while using it (like full-screen). */ static bool gpencil_area_exists(bContext *C, ScrArea *area_test) { bScreen *screen = CTX_wm_screen(C); @@ -3888,7 +3888,7 @@ static int gpencil_draw_modal(bContext *C, wmOperator *op, const wmEvent *event) } } - /* gpencil modal operator stores area, which can be removed while using it (like fullscreen) */ + /* gpencil modal operator stores area, which can be removed while using it (like full-screen). */ if (0 == gpencil_area_exists(C, p->area)) { estate = OPERATOR_CANCELLED; } diff --git a/source/blender/editors/include/ED_anim_api.h b/source/blender/editors/include/ED_anim_api.h index ee87de5774a..6079aca0199 100644 --- a/source/blender/editors/include/ED_anim_api.h +++ b/source/blender/editors/include/ED_anim_api.h @@ -101,16 +101,16 @@ typedef struct bAnimContext { /* Main Data container types */ typedef enum eAnimCont_Types { ANIMCONT_NONE = 0, /* invalid or no data */ - ANIMCONT_ACTION = 1, /* action (bAction) */ - ANIMCONT_SHAPEKEY = 2, /* shapekey (Key) */ + ANIMCONT_ACTION = 1, /* action (#bAction) */ + ANIMCONT_SHAPEKEY = 2, /* shape-key (#Key) */ ANIMCONT_GPENCIL = 3, /* grease pencil (screen) */ - ANIMCONT_DOPESHEET = 4, /* dopesheet (bDopesheet) */ - ANIMCONT_FCURVES = 5, /* animation F-Curves (bDopesheet) */ - ANIMCONT_DRIVERS = 6, /* drivers (bDopesheet) */ - ANIMCONT_NLA = 7, /* nla (bDopesheet) */ - ANIMCONT_CHANNEL = 8, /* animation channel (bAnimListElem) */ - ANIMCONT_MASK = 9, /* mask dopesheet */ - ANIMCONT_TIMELINE = 10, /* "timeline" editor (bDopeSheet) */ + ANIMCONT_DOPESHEET = 4, /* dope-sheet (#bDopesheet) */ + ANIMCONT_FCURVES = 5, /* animation F-Curves (#bDopesheet) */ + ANIMCONT_DRIVERS = 6, /* drivers (#bDopesheet) */ + ANIMCONT_NLA = 7, /* NLA (#bDopesheet) */ + ANIMCONT_CHANNEL = 8, /* animation channel (#bAnimListElem) */ + ANIMCONT_MASK = 9, /* mask dope-sheet */ + ANIMCONT_TIMELINE = 10, /* "timeline" editor (#bDopeSheet) */ } eAnimCont_Types; /** \} */ diff --git a/source/blender/editors/include/ED_screen.h b/source/blender/editors/include/ED_screen.h index eeed1c9b286..144fa4e0b93 100644 --- a/source/blender/editors/include/ED_screen.h +++ b/source/blender/editors/include/ED_screen.h @@ -353,8 +353,8 @@ struct ScrArea *ED_screen_state_toggle(struct bContext *C, struct ScrArea *area, short state); /** - * Wrapper to open a temporary space either as fullscreen space, or as separate window, as defined - * by \a display_type. + * Wrapper to open a temporary space either as full-screen space, or as separate window, + * as defined by \a display_type. * * \param title: Title to set for the window, if a window is spawned. * \param x, y: Position of the window, if a window is spawned. diff --git a/source/blender/editors/include/ED_screen_types.h b/source/blender/editors/include/ED_screen_types.h index 21bb412d072..bf64be9f7a7 100644 --- a/source/blender/editors/include/ED_screen_types.h +++ b/source/blender/editors/include/ED_screen_types.h @@ -112,7 +112,7 @@ enum { */ AZONE_REGION, /** - * Used when in editor fullscreen draw a corner to return to normal mode. + * Used when in editor full-screen draw a corner to return to normal mode. */ AZONE_FULLSCREEN, /** diff --git a/source/blender/editors/include/ED_space_api.h b/source/blender/editors/include/ED_space_api.h index c69698f3f73..07d4f43bb2b 100644 --- a/source/blender/editors/include/ED_space_api.h +++ b/source/blender/editors/include/ED_space_api.h @@ -50,7 +50,7 @@ void ED_spacetype_spreadsheet(void); /** \} */ /* -------------------------------------------------------------------- */ -/** \name Spacetype Static Data +/** \name Space-type Static Data * Calls for instancing and freeing space-type static data called in #WM_init_exit * \{ */ diff --git a/source/blender/editors/interface/eyedroppers/interface_eyedropper.c b/source/blender/editors/interface/eyedroppers/interface_eyedropper.c index c6fb8f0ab68..e49955512a1 100644 --- a/source/blender/editors/interface/eyedroppers/interface_eyedropper.c +++ b/source/blender/editors/interface/eyedroppers/interface_eyedropper.c @@ -41,7 +41,7 @@ wmKeyMap *eyedropper_modal_keymap(wmKeyConfig *keyconf) wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "Eyedropper Modal Map"); - /* this function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return NULL; } diff --git a/source/blender/editors/interface/interface_layout.c b/source/blender/editors/interface/interface_layout.c index 94d17ed3c88..d002dd643c3 100644 --- a/source/blender/editors/interface/interface_layout.c +++ b/source/blender/editors/interface/interface_layout.c @@ -694,7 +694,7 @@ static void ui_item_array(uiLayout *layout, else { /* Even if 'expand' is false, we expand anyway. */ - /* layout for known array subtypes */ + /* Layout for known array sub-types. */ char str[3] = {'\0'}; if (!icon_only && show_text) { diff --git a/source/blender/editors/interface/interface_regions.cc b/source/blender/editors/interface/interface_regions.cc index 1770805cf59..63c4a6f9c42 100644 --- a/source/blender/editors/interface/interface_regions.cc +++ b/source/blender/editors/interface/interface_regions.cc @@ -45,6 +45,6 @@ void ui_region_temp_remove(bContext *C, bScreen *screen, ARegion *region) } ED_region_exit(C, region); - BKE_area_region_free(nullptr, region); /* nullptr: no spacetype */ + BKE_area_region_free(nullptr, region); /* nullptr: no space-type. */ BLI_freelinkN(&screen->regionbase, region); } diff --git a/source/blender/editors/mask/mask_shapekey.c b/source/blender/editors/mask/mask_shapekey.c index 48944c081a8..77595aa0694 100644 --- a/source/blender/editors/mask/mask_shapekey.c +++ b/source/blender/editors/mask/mask_shapekey.c @@ -136,9 +136,9 @@ static int mask_shape_key_feather_reset_exec(bContext *C, wmOperator *UNUSED(op) MaskLayerShape *mask_layer_shape_reset; MaskLayerShape *mask_layer_shape; - /* get the shapekey of the current state */ + /* Get the shape-key of the current state. */ mask_layer_shape_reset = BKE_mask_layer_shape_alloc(mask_layer, frame); - /* initialize from mask - as if inseting a keyframe */ + /* Initialize from mask - as if inserting a keyframe. */ BKE_mask_layer_shape_from_mask(mask_layer, mask_layer_shape_reset); for (mask_layer_shape = mask_layer->splines_shapes.first; mask_layer_shape; diff --git a/source/blender/editors/mesh/editmesh_bevel.c b/source/blender/editors/mesh/editmesh_bevel.c index 47cdc4ebe56..0a6feeb3665 100644 --- a/source/blender/editors/mesh/editmesh_bevel.c +++ b/source/blender/editors/mesh/editmesh_bevel.c @@ -649,7 +649,7 @@ wmKeyMap *bevel_modal_keymap(wmKeyConfig *keyconf) wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "Bevel Modal Map"); - /* This function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return NULL; } diff --git a/source/blender/editors/mesh/editmesh_knife.c b/source/blender/editors/mesh/editmesh_knife.c index b330ef4dcc9..156698be567 100644 --- a/source/blender/editors/mesh/editmesh_knife.c +++ b/source/blender/editors/mesh/editmesh_knife.c @@ -4378,7 +4378,7 @@ wmKeyMap *knifetool_modal_keymap(wmKeyConfig *keyconf) wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "Knife Tool Modal Map"); - /* This function is called for each spacetype, only needs to add map once. */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return NULL; } diff --git a/source/blender/editors/object/object_data_transform.c b/source/blender/editors/object/object_data_transform.c index 63513eac965..cb66010c497 100644 --- a/source/blender/editors/object/object_data_transform.c +++ b/source/blender/editors/object/object_data_transform.c @@ -7,7 +7,7 @@ * Use to transform object origins only. * * This is a small API to store & apply transformations to object data, - * where a transformation matrix can be continually applied ontop of the original values + * where a transformation matrix can be continually applied on top of the original values * so we don't lose precision over time. */ diff --git a/source/blender/editors/object/object_modifier.cc b/source/blender/editors/object/object_modifier.cc index 38ebae6ba83..f82c0938b51 100644 --- a/source/blender/editors/object/object_modifier.cc +++ b/source/blender/editors/object/object_modifier.cc @@ -1556,7 +1556,7 @@ void OBJECT_OT_modifier_apply(wmOperatorType *ot) /** \} */ /* ------------------------------------------------------------------- */ -/** \name Apply Modifier As Shapekey Operator +/** \name Apply Modifier As Shape-Key Operator * \{ */ static bool modifier_apply_as_shapekey_poll(bContext *C) diff --git a/source/blender/editors/physics/particle_edit.c b/source/blender/editors/physics/particle_edit.c index 4d9b9838373..99e42710b49 100644 --- a/source/blender/editors/physics/particle_edit.c +++ b/source/blender/editors/physics/particle_edit.c @@ -3988,7 +3988,7 @@ static void brush_puff(PEData *data, int point_index, float mouse_distance) /* Translate (not rotate) the rest of the hair if its not selected. */ { /* NOLINTNEXTLINE: readability-redundant-preprocessor */ -# if 0 /* kindof works but looks worse than what's below */ +# if 0 /* Kind of works but looks worse than what's below. */ /* Move the unselected point on a vector based on the * hair direction and the offset */ diff --git a/source/blender/editors/render/render_view.cc b/source/blender/editors/render/render_view.cc index 9a16c910205..7569b3600a1 100644 --- a/source/blender/editors/render/render_view.cc +++ b/source/blender/editors/render/render_view.cc @@ -74,7 +74,7 @@ static ScrArea *find_area_showing_r_result(bContext *C, Scene *scene, wmWindow * ScrArea *area = nullptr; SpaceImage *sima; - /* find an imagewindow showing render result */ + /* find an image-window showing render result */ for (*win = static_cast<wmWindow *>(wm->windows.first); *win; *win = (*win)->next) { if (WM_window_get_active_scene(*win) == scene) { const bScreen *screen = WM_window_get_active_screen(*win); @@ -102,7 +102,7 @@ static ScrArea *find_area_image_empty(bContext *C) ScrArea *area; SpaceImage *sima; - /* find an imagewindow showing render result */ + /* find an image-window showing render result */ for (area = static_cast<ScrArea *>(screen->areabase.first); area; area = area->next) { if (area->spacetype == SPACE_IMAGE) { sima = static_cast<SpaceImage *>(area->spacedata.first); diff --git a/source/blender/editors/screen/area.c b/source/blender/editors/screen/area.c index 08565a86ee7..25e16bee558 100644 --- a/source/blender/editors/screen/area.c +++ b/source/blender/editors/screen/area.c @@ -175,7 +175,7 @@ void ED_area_do_refresh(bContext *C, ScrArea *area) } /** - * \brief Corner widget use for quitting fullscreen. + * \brief Corner widget use for quitting full-screen. */ static void area_draw_azone_fullscreen( short UNUSED(x1), short UNUSED(y1), short x2, short y2, float alpha) @@ -845,7 +845,7 @@ void ED_workspace_status_text(bContext *C, const char *str) static void area_azone_init(wmWindow *win, const bScreen *screen, ScrArea *area) { - /* reinitialize entirely, regions and fullscreen add azones too */ + /* reinitialize entirely, regions and full-screen add azones too */ BLI_freelistN(&area->actionzones); if (screen->state != SCREENNORMAL) { @@ -2578,8 +2578,8 @@ void ED_area_prevspace(bContext *C, ScrArea *area) /* no change */ return; } - /* If this is a stacked fullscreen, changing to previous area exits it (meaning we're still in a - * fullscreen, but not in a stacked one). */ + /* If this is a stacked full-screen, changing to previous area exits it (meaning we're still in a + * full-screen, but not in a stacked one). */ area->flag &= ~AREA_FLAG_STACKED_FULLSCREEN; ED_area_tag_redraw(area); diff --git a/source/blender/editors/screen/screen_edit.c b/source/blender/editors/screen/screen_edit.c index 68a47805b8a..bc7006d2ac7 100644 --- a/source/blender/editors/screen/screen_edit.c +++ b/source/blender/editors/screen/screen_edit.c @@ -1275,7 +1275,7 @@ void ED_screen_full_prevspace(bContext *C, ScrArea *area) BLI_assert(area->full); if (area->flag & AREA_FLAG_STACKED_FULLSCREEN) { - /* stacked fullscreen -> only go back to previous area and don't toggle out of fullscreen */ + /* Stacked full-screen -> only go back to previous area and don't toggle out of full-screen. */ ED_area_prevspace(C, area); } else { @@ -1306,8 +1306,8 @@ void ED_screen_full_restore(bContext *C, ScrArea *area) bScreen *screen = CTX_wm_screen(C); short state = (screen ? screen->state : SCREENMAXIMIZED); - /* if fullscreen area has a temporary space (such as a file browser or fullscreen render - * overlaid on top of an existing setup) then return to the previous space */ + /* If full-screen area has a temporary space (such as a file browser or full-screen render + * overlaid on top of an existing setup) then return to the previous space. */ if (sl->next) { if (sl->link_flag & SPACE_FLAG_TYPE_TEMPORARY) { diff --git a/source/blender/editors/screen/screen_intern.h b/source/blender/editors/screen/screen_intern.h index 4c2d94e2018..feda68a51a7 100644 --- a/source/blender/editors/screen/screen_intern.h +++ b/source/blender/editors/screen/screen_intern.h @@ -53,7 +53,7 @@ typedef enum eScreenAxis { /* area.c */ /** - * we swap spaces for fullscreen to keep all allocated data area vertices were set + * We swap spaces for full-screen to keep all allocated data area vertices were set. */ void ED_area_data_copy(ScrArea *area_dst, ScrArea *area_src, bool do_free); void ED_area_data_swap(ScrArea *area_dst, ScrArea *area_src); diff --git a/source/blender/editors/screen/screen_ops.c b/source/blender/editors/screen/screen_ops.c index 5331747beae..9307efce68b 100644 --- a/source/blender/editors/screen/screen_ops.c +++ b/source/blender/editors/screen/screen_ops.c @@ -3267,7 +3267,7 @@ static int screen_maximize_area_exec(bContext *C, wmOperator *op) BLI_assert(!screen->temp); - /* search current screen for 'fullscreen' areas */ + /* search current screen for 'full-screen' areas */ /* prevents restoring info header, when mouse is over it */ LISTBASE_FOREACH (ScrArea *, area_iter, &screen->areabase) { if (area_iter->full) { diff --git a/source/blender/editors/sculpt_paint/paint_stroke.c b/source/blender/editors/sculpt_paint/paint_stroke.c index 60f4a9d59a5..73d52febfc6 100644 --- a/source/blender/editors/sculpt_paint/paint_stroke.c +++ b/source/blender/editors/sculpt_paint/paint_stroke.c @@ -1140,7 +1140,7 @@ struct wmKeyMap *paint_stroke_modal_keymap(struct wmKeyConfig *keyconf) struct wmKeyMap *keymap = WM_modalkeymap_find(keyconf, name); - /* this function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (!keymap) { keymap = WM_modalkeymap_ensure(keyconf, name, modal_items); } diff --git a/source/blender/editors/sculpt_paint/sculpt_expand.c b/source/blender/editors/sculpt_paint/sculpt_expand.c index 414a855ab2f..53972709a3e 100644 --- a/source/blender/editors/sculpt_paint/sculpt_expand.c +++ b/source/blender/editors/sculpt_paint/sculpt_expand.c @@ -2244,7 +2244,7 @@ void sculpt_expand_modal_keymap(wmKeyConfig *keyconf) static const char *name = "Sculpt Expand Modal"; wmKeyMap *keymap = WM_modalkeymap_find(keyconf, name); - /* This function is called for each spacetype, only needs to add map once. */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return; } diff --git a/source/blender/editors/space_action/action_data.c b/source/blender/editors/space_action/action_data.c index 8f97a58451e..79047b171ef 100644 --- a/source/blender/editors/space_action/action_data.c +++ b/source/blender/editors/space_action/action_data.c @@ -169,7 +169,7 @@ static bool action_new_poll(bContext *C) SpaceAction *saction = (SpaceAction *)CTX_wm_space_data(C); Object *ob = CTX_data_active_object(C); - /* For now, actions are only for the active object, and on object and shapekey levels... */ + /* For now, actions are only for the active object, and on object and shape-key levels... */ if (saction->mode == SACTCONT_ACTION) { /* XXX: This assumes that actions are assigned to the active object in this mode */ if (ob) { @@ -460,7 +460,8 @@ static bool action_stash_create_poll(bContext *C) Scene *scene = CTX_data_scene(C); if (!(scene->flag & SCE_NLA_EDIT_ON)) { - /* For now, actions are only for the active object, and on object and shapekey levels... */ + /* For now, actions are only for the active object, and on object and shape-key levels... + */ return ELEM(saction->mode, SACTCONT_ACTION, SACTCONT_SHAPEKEY); } } diff --git a/source/blender/editors/space_node/node_edit.cc b/source/blender/editors/space_node/node_edit.cc index f07a1205c6b..f9c50aeac64 100644 --- a/source/blender/editors/space_node/node_edit.cc +++ b/source/blender/editors/space_node/node_edit.cc @@ -2532,7 +2532,7 @@ static int ntree_socket_change_type_exec(bContext *C, wmOperator *op) return OPERATOR_FINISHED; } - /* Don't handle subtypes for now. */ + /* Don't handle sub-types for now. */ nodeModifySocketType(ntree, nullptr, iosock, socket_type->idname); /* Need the extra update here because the loop above does not check for valid links in the node diff --git a/source/blender/editors/space_outliner/tree/tree_display_override_library_hierarchies.cc b/source/blender/editors/space_outliner/tree/tree_display_override_library_hierarchies.cc index fa4479d0d9d..2150d2b211a 100644 --- a/source/blender/editors/space_outliner/tree/tree_display_override_library_hierarchies.cc +++ b/source/blender/editors/space_outliner/tree/tree_display_override_library_hierarchies.cc @@ -324,7 +324,7 @@ static bool id_is_in_override_hierarchy(const Main &bmain, if (ID_IS_OVERRIDE_LIBRARY_VIRTUAL(&id)) { /* In many cases, `relationship_parent_id` is the owner, but not always (e.g. there can be - * drivers directly between an object and a shapekey). */ + * drivers directly between an object and a shape-key). */ BKE_lib_override_library_get(const_cast<Main *>(&bmain), const_cast<ID *>(&id), const_cast<ID *>(&relationship_parent_id), diff --git a/source/blender/editors/space_sequencer/space_sequencer.c b/source/blender/editors/space_sequencer/space_sequencer.c index 538cfad14f5..508f18ade5a 100644 --- a/source/blender/editors/space_sequencer/space_sequencer.c +++ b/source/blender/editors/space_sequencer/space_sequencer.c @@ -229,7 +229,7 @@ static void sequencer_free(SpaceLink *sl) } } -/* Spacetype init callback. */ +/* Space-type init callback. */ static void sequencer_init(struct wmWindowManager *UNUSED(wm), ScrArea *UNUSED(area)) { } diff --git a/source/blender/editors/space_view3d/view3d_draw.c b/source/blender/editors/space_view3d/view3d_draw.c index e0939b714a0..219c70cffae 100644 --- a/source/blender/editors/space_view3d/view3d_draw.c +++ b/source/blender/editors/space_view3d/view3d_draw.c @@ -1353,7 +1353,7 @@ static void draw_selected_name( } } else if (ELEM(ob->type, OB_MESH, OB_LATTICE, OB_CURVES_LEGACY)) { - /* try to display active bone and active shapekey too (if they exist) */ + /* Try to display active bone and active shape-key too (if they exist). */ if (ob->type == OB_MESH && ob->mode & OB_MODE_WEIGHT_PAINT) { Object *armobj = BKE_object_pose_armature_get(ob); diff --git a/source/blender/editors/space_view3d/view3d_navigate_dolly.c b/source/blender/editors/space_view3d/view3d_navigate_dolly.c index 376e8ba190b..df0f4e6e94b 100644 --- a/source/blender/editors/space_view3d/view3d_navigate_dolly.c +++ b/source/blender/editors/space_view3d/view3d_navigate_dolly.c @@ -41,7 +41,7 @@ void viewdolly_modal_keymap(wmKeyConfig *keyconf) wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "View3D Dolly Modal"); - /* this function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return; } diff --git a/source/blender/editors/space_view3d/view3d_navigate_fly.c b/source/blender/editors/space_view3d/view3d_navigate_fly.c index b607abe8226..3e83f8085c7 100644 --- a/source/blender/editors/space_view3d/view3d_navigate_fly.c +++ b/source/blender/editors/space_view3d/view3d_navigate_fly.c @@ -122,7 +122,7 @@ void fly_modal_keymap(wmKeyConfig *keyconf) wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "View3D Fly Modal"); - /* this function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return; } diff --git a/source/blender/editors/space_view3d/view3d_navigate_move.c b/source/blender/editors/space_view3d/view3d_navigate_move.c index e236b702fb8..9de0a2ae4c2 100644 --- a/source/blender/editors/space_view3d/view3d_navigate_move.c +++ b/source/blender/editors/space_view3d/view3d_navigate_move.c @@ -35,7 +35,7 @@ void viewmove_modal_keymap(wmKeyConfig *keyconf) wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "View3D Move Modal"); - /* this function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return; } diff --git a/source/blender/editors/space_view3d/view3d_navigate_rotate.c b/source/blender/editors/space_view3d/view3d_navigate_rotate.c index 20385e15c48..10adf238001 100644 --- a/source/blender/editors/space_view3d/view3d_navigate_rotate.c +++ b/source/blender/editors/space_view3d/view3d_navigate_rotate.c @@ -37,7 +37,7 @@ void viewrotate_modal_keymap(wmKeyConfig *keyconf) wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "View3D Rotate Modal"); - /* this function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return; } diff --git a/source/blender/editors/space_view3d/view3d_navigate_walk.c b/source/blender/editors/space_view3d/view3d_navigate_walk.c index 7e537d0c141..3e0ce892b5a 100644 --- a/source/blender/editors/space_view3d/view3d_navigate_walk.c +++ b/source/blender/editors/space_view3d/view3d_navigate_walk.c @@ -170,7 +170,7 @@ void walk_modal_keymap(wmKeyConfig *keyconf) wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "View3D Walk Modal"); - /* this function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return; } diff --git a/source/blender/editors/space_view3d/view3d_navigate_zoom.c b/source/blender/editors/space_view3d/view3d_navigate_zoom.c index 9230aa09b1a..40df2b1a9c9 100644 --- a/source/blender/editors/space_view3d/view3d_navigate_zoom.c +++ b/source/blender/editors/space_view3d/view3d_navigate_zoom.c @@ -41,7 +41,7 @@ void viewzoom_modal_keymap(wmKeyConfig *keyconf) wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "View3D Zoom Modal"); - /* this function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return; } diff --git a/source/blender/editors/transform/transform_convert_graph.c b/source/blender/editors/transform/transform_convert_graph.c index 4bcbce8bc83..27e6c8a25e1 100644 --- a/source/blender/editors/transform/transform_convert_graph.c +++ b/source/blender/editors/transform/transform_convert_graph.c @@ -639,7 +639,7 @@ static bool fcu_test_selected(FCurve *fcu) return 0; } -/* this function is called on recalcData to apply the transforms applied +/* This function is called on recalcData to apply the transforms applied * to the transdata on to the actual keyframe data */ static void flushTransGraphData(TransInfo *t) diff --git a/source/blender/functions/intern/field.cc b/source/blender/functions/intern/field.cc index 2a62133e851..8fb56d7aa11 100644 --- a/source/blender/functions/intern/field.cc +++ b/source/blender/functions/intern/field.cc @@ -574,7 +574,7 @@ bool IndexFieldInput::is_equal_to(const fn::FieldNode &other) const /** \} */ /* -------------------------------------------------------------------- */ -/** \name Fieldnode +/** \name #FieldNode * \{ */ /* Avoid generating the destructor in every translation unit. */ @@ -583,7 +583,7 @@ FieldNode::~FieldNode() = default; /** \} */ /* -------------------------------------------------------------------- */ -/** \name Fieldoperation +/** \name #FieldOperation * \{ */ FieldOperation::FieldOperation(std::shared_ptr<const MultiFunction> function, @@ -660,7 +660,7 @@ FieldOperation::FieldOperation(const MultiFunction &function, Vector<GField> inp /** \} */ /* -------------------------------------------------------------------- */ -/** \name Fieldinput +/** \name #FieldInput * \{ */ FieldInput::FieldInput(const CPPType &type, std::string debug_name) @@ -678,7 +678,7 @@ FieldInput::~FieldInput() = default; /** \} */ /* -------------------------------------------------------------------- */ -/** \name Fieldconstant +/** \name #FieldConstant * \{ */ FieldConstant::FieldConstant(const CPPType &type, const void *value) @@ -714,7 +714,7 @@ GPointer FieldConstant::value() const /** \} */ /* -------------------------------------------------------------------- */ -/** \name Fieldevaluator +/** \name #FieldEvaluator * \{ */ static IndexMask index_mask_from_selection(const IndexMask full_mask, diff --git a/source/blender/imbuf/IMB_imbuf_types.h b/source/blender/imbuf/IMB_imbuf_types.h index 03bb11d0cf6..81e9420c8ba 100644 --- a/source/blender/imbuf/IMB_imbuf_types.h +++ b/source/blender/imbuf/IMB_imbuf_types.h @@ -125,7 +125,7 @@ enum eImbFileType { typedef struct ImbFormatOptions { short flag; - /** quality serves dual purpose as quality number for jpeg or compression amount for png */ + /** Quality serves dual purpose as quality number for JPEG or compression amount for PNG. */ char quality; } ImbFormatOptions; diff --git a/source/blender/imbuf/intern/cineon/dpxlib.c b/source/blender/imbuf/intern/cineon/dpxlib.c index 494bf37cfe7..be8fab26301 100644 --- a/source/blender/imbuf/intern/cineon/dpxlib.c +++ b/source/blender/imbuf/intern/cineon/dpxlib.c @@ -4,7 +4,7 @@ /** \file * \ingroup imbcineon * - * Dpx image file format library routines. + * DPX image file format library routines. */ #include "dpxlib.h" diff --git a/source/blender/imbuf/intern/dds/DirectDrawSurface.cpp b/source/blender/imbuf/intern/dds/DirectDrawSurface.cpp index 4e5dc9ce560..39432827467 100644 --- a/source/blender/imbuf/intern/dds/DirectDrawSurface.cpp +++ b/source/blender/imbuf/intern/dds/DirectDrawSurface.cpp @@ -942,7 +942,7 @@ bool DirectDrawSurface::isSupported() const if (isTextureCube() && (header.caps.caps2 & DDSCAPS2_CUBEMAP_ALL_FACES) != DDSCAPS2_CUBEMAP_ALL_FACES) { - /* Cubemaps must contain all faces. */ + /* Cube-maps must contain all faces. */ return false; } diff --git a/source/blender/imbuf/intern/openexr/openexr_api.cpp b/source/blender/imbuf/intern/openexr/openexr_api.cpp index b4ccdfab9a5..6d8c4a5c446 100644 --- a/source/blender/imbuf/intern/openexr/openexr_api.cpp +++ b/source/blender/imbuf/intern/openexr/openexr_api.cpp @@ -708,7 +708,8 @@ struct ExrHandle { ListBase channels; /* flattened out, ExrChannel */ ListBase layers; /* hierarchical, pointing in end to ExrChannel */ - int num_half_channels; /* used during filr save, allows faster temporary buffers allocation */ + /** Used during file save, allows faster temporary buffers allocation. */ + int num_half_channels; }; /* flattened out channel */ @@ -1462,7 +1463,7 @@ static int imb_exr_split_channel_name(ExrChannel *echan, char *layname, char *pa const char *end = name + strlen(name); const char *token; - /* some multilayers have the combined buffer with names A B G R saved */ + /* Some multi-layers have the combined buffer with names A B G R saved. */ if (name[1] == 0) { echan->chan_id = BLI_toupper_ascii(name[0]); layname[0] = '\0'; diff --git a/source/blender/imbuf/intern/scaling.c b/source/blender/imbuf/intern/scaling.c index 05bee77a6cb..acffc4e7f8f 100644 --- a/source/blender/imbuf/intern/scaling.c +++ b/source/blender/imbuf/intern/scaling.c @@ -828,7 +828,7 @@ static void q_scale_float( } /** - * q_scale_linear_interpolation (derived from ppmqscale, http://libdv.sf.net) + * q_scale_linear_interpolation (derived from `ppmqscale`, http://libdv.sf.net) * * q stands for quick _and_ quality :) * diff --git a/source/blender/makesdna/DNA_constraint_types.h b/source/blender/makesdna/DNA_constraint_types.h index 8e0ce68f71a..04887f1223c 100644 --- a/source/blender/makesdna/DNA_constraint_types.h +++ b/source/blender/makesdna/DNA_constraint_types.h @@ -181,7 +181,7 @@ typedef struct bKinematicConstraint { float orientweight; /** CopyPose: for target-less IK. */ float grabtarget[3]; - /** Subtype of IK constraint: eConstraint_IK_Type. */ + /** Sub-type of IK constraint: #eConstraint_IK_Type. */ short type; /** Distance: how to limit in relation to clamping sphere: LIMITDIST_... */ short mode; diff --git a/source/blender/makesdna/DNA_node_types.h b/source/blender/makesdna/DNA_node_types.h index 735f5c7b20a..a416e184d2b 100644 --- a/source/blender/makesdna/DNA_node_types.h +++ b/source/blender/makesdna/DNA_node_types.h @@ -992,7 +992,7 @@ typedef struct NodeGlare { char _pad1[4]; } NodeGlare; -/** Tonemap node. */ +/** Tone-map node. */ typedef struct NodeTonemap { float key, offset, gamma; float f, m, a, c; diff --git a/source/blender/makesdna/DNA_scene_types.h b/source/blender/makesdna/DNA_scene_types.h index f184460cba4..2cde54bc0ed 100644 --- a/source/blender/makesdna/DNA_scene_types.h +++ b/source/blender/makesdna/DNA_scene_types.h @@ -404,9 +404,9 @@ typedef struct ImageFormatData { /** Generic options for all image types, alpha zbuffer. */ char flag; - /** (0 - 100), eg: jpeg quality. */ + /** (0 - 100), eg: JPEG quality. */ char quality; - /** (0 - 100), eg: png compression. */ + /** (0 - 100), eg: PNG compression. */ char compress; /* --- format specific --- */ @@ -1500,12 +1500,12 @@ typedef struct ToolSettings { /* Transform */ char transform_pivot_point; char transform_flag; - /** Snap elements (per spacetype), #eSnapMode. */ + /** Snap elements (per space-type), #eSnapMode. */ char _pad1[1]; short snap_mode; char snap_node_mode; char snap_uv_mode; - /** Generic flags (per spacetype), #eSnapFlag. */ + /** Generic flags (per space-type), #eSnapFlag. */ short snap_flag; short snap_flag_node; short snap_flag_seq; diff --git a/source/blender/makesdna/DNA_screen_types.h b/source/blender/makesdna/DNA_screen_types.h index 9b999e4426f..ba0ccabb16c 100644 --- a/source/blender/makesdna/DNA_screen_types.h +++ b/source/blender/makesdna/DNA_screen_types.h @@ -477,7 +477,7 @@ typedef struct ARegion { short do_draw_paintcursor; /** Private, set for indicate drawing overlapped. */ short overlap; - /** Temporary copy of flag settings for clean fullscreen. */ + /** Temporary copy of flag settings for clean full-screen. */ short flagfullscreen; /** Callbacks for this region type. */ diff --git a/source/blender/makesdna/DNA_workspace_types.h b/source/blender/makesdna/DNA_workspace_types.h index a72689badb1..1a6e19c31ad 100644 --- a/source/blender/makesdna/DNA_workspace_types.h +++ b/source/blender/makesdna/DNA_workspace_types.h @@ -59,7 +59,7 @@ typedef struct bToolRef { /** Use to avoid initializing the same tool multiple times. */ short tag; - /** #bToolKey (spacetype, mode), used in 'WM_api.h' */ + /** #bToolKey (space-type, mode), used in 'WM_api.h' */ short space_type; /** * Value depends on the 'space_type', object mode for 3D view, image editor has own mode too. diff --git a/source/blender/makesrna/RNA_types.h b/source/blender/makesrna/RNA_types.h index 5346228050a..e7766e4a05e 100644 --- a/source/blender/makesrna/RNA_types.h +++ b/source/blender/makesrna/RNA_types.h @@ -120,7 +120,7 @@ typedef enum PropertyScaleType { /** * \note Also update enums in bpy_props.c and rna_rna.c when adding items here. - * Watch it: these values are written to files as part of node socket button subtypes! + * Watch it: these values are written to files as part of node socket button sub-types! */ typedef enum PropertySubType { PROP_NONE = 0, @@ -719,7 +719,7 @@ typedef enum StructFlag { STRUCT_CONTAINS_DATABLOCK_IDPROPERTIES = (1 << 8), /** Added to type-map #BlenderRNA.structs_map */ STRUCT_PUBLIC_NAMESPACE = (1 << 9), - /** All subtypes are added too. */ + /** All sub-types are added too. */ STRUCT_PUBLIC_NAMESPACE_INHERIT = (1 << 10), /** * When the #PointerRNA.owner_id is NULL, this signifies the property should be accessed diff --git a/source/blender/makesrna/intern/rna_access.c b/source/blender/makesrna/intern/rna_access.c index 835265b1986..e5932f33604 100644 --- a/source/blender/makesrna/intern/rna_access.c +++ b/source/blender/makesrna/intern/rna_access.c @@ -1135,7 +1135,7 @@ char RNA_property_array_item_char(PropertyRNA *prop, int index) int RNA_property_array_item_index(PropertyRNA *prop, char name) { - /* Don't use custom property subtypes in RNA path lookup. */ + /* Don't use custom property sub-types in RNA path lookup. */ PropertySubType subtype = rna_ensure_property(prop)->subtype; /* get index based on string name/alias */ diff --git a/source/blender/makesrna/intern/rna_nodetree.c b/source/blender/makesrna/intern/rna_nodetree.c index caeee35a80a..dbf5f434248 100644 --- a/source/blender/makesrna/intern/rna_nodetree.c +++ b/source/blender/makesrna/intern/rna_nodetree.c @@ -1892,7 +1892,7 @@ static void rna_Node_unregister(Main *UNUSED(bmain), StructRNA *type) } /* Generic internal registration function. - * Can be used to implement callbacks for registerable RNA node subtypes. + * Can be used to implement callbacks for registerable RNA node sub-types. */ static bNodeType *rna_Node_register_base(Main *bmain, ReportList *reports, diff --git a/source/blender/makesrna/intern/rna_space.c b/source/blender/makesrna/intern/rna_space.c index 0a3c7827ed0..bf25e3214f8 100644 --- a/source/blender/makesrna/intern/rna_space.c +++ b/source/blender/makesrna/intern/rna_space.c @@ -6632,7 +6632,7 @@ static void rna_def_fileselect_params(BlenderRNA *brna) RNA_def_property_ui_text(prop, "Title", "Title for the file browser"); RNA_def_property_clear_flag(prop, PROP_EDITABLE); - /* Use BYTESTRING rather than DIRPATH as subtype so UI code doesn't add OT_directory_browse + /* Use BYTESTRING rather than DIRPATH as sub-type so UI code doesn't add OT_directory_browse * button when displaying this prop in the file browser (it would just open a file browser). That * should be the only effective difference between the two. */ prop = RNA_def_property(srna, "directory", PROP_STRING, PROP_BYTESTRING); diff --git a/source/blender/makesrna/intern/rna_texture.c b/source/blender/makesrna/intern/rna_texture.c index 3b28dc70e9e..26849bfa622 100644 --- a/source/blender/makesrna/intern/rna_texture.c +++ b/source/blender/makesrna/intern/rna_texture.c @@ -1235,7 +1235,7 @@ static void rna_def_texture_image(BlenderRNA *brna) # if 0 /* XXX: did this as an array, but needs better descriptions than "1 2 3 4" - * perhaps a new subtype could be added? + * perhaps a new sub-type could be added? * --I actually used single values for this, maybe change later with a RNA_Rect thing? */ prop = RNA_def_property(srna, "crop_rectangle", PROP_FLOAT, PROP_NONE); RNA_def_property_float_sdna(prop, NULL, "cropxmin"); diff --git a/source/blender/makesrna/intern/rna_userdef.c b/source/blender/makesrna/intern/rna_userdef.c index 0031e023d39..b2f37ee2ae1 100644 --- a/source/blender/makesrna/intern/rna_userdef.c +++ b/source/blender/makesrna/intern/rna_userdef.c @@ -1685,7 +1685,7 @@ static void rna_def_userdef_theme_space_common(StructRNA *srna) RNA_def_property_update(prop, 0, "rna_userdef_theme_update"); /* buttons */ - /* if (! ELEM(spacetype, SPACE_PROPERTIES, SPACE_OUTLINER)) { */ + // if (!ELEM(spacetype, SPACE_PROPERTIES, SPACE_OUTLINER)) { prop = RNA_def_property(srna, "button", PROP_FLOAT, PROP_COLOR_GAMMA); RNA_def_property_array(prop, 4); RNA_def_property_ui_text(prop, "Region Background", ""); @@ -1737,7 +1737,7 @@ static void rna_def_userdef_theme_space_common(StructRNA *srna) RNA_def_property_ui_text(prop, "Tab Outline", ""); RNA_def_property_update(prop, 0, "rna_userdef_theme_update"); - /* } */ + // } } static void rna_def_userdef_theme_space_gradient(BlenderRNA *brna) diff --git a/source/blender/modifiers/intern/MOD_skin.c b/source/blender/modifiers/intern/MOD_skin.c index 4f79a0d56ec..b01bcec0bc1 100644 --- a/source/blender/modifiers/intern/MOD_skin.c +++ b/source/blender/modifiers/intern/MOD_skin.c @@ -1734,7 +1734,7 @@ static void skin_smooth_hulls(BMesh *bm, } } - /* Add temporary shapekey layer to store original coordinates */ + /* Add temporary shape-key layer to store original coordinates. */ BM_data_layer_add(bm, &bm->vdata, CD_SHAPEKEY); skey = CustomData_number_of_layers(&bm->vdata, CD_SHAPEKEY) - 1; BM_ITER_MESH (v, &iter, bm, BM_VERTS_OF_MESH) { diff --git a/source/blender/nodes/texture/node_texture_tree.c b/source/blender/nodes/texture/node_texture_tree.c index 9506869a0e9..81d0b0fbc84 100644 --- a/source/blender/nodes/texture/node_texture_tree.c +++ b/source/blender/nodes/texture/node_texture_tree.c @@ -251,7 +251,7 @@ bNodeTreeExec *ntreeTexBeginExecTree(bNodeTree *ntree) exec = ntreeTexBeginExecTree_internal(&context, ntree, NODE_INSTANCE_KEY_BASE); - /* XXX this should not be necessary, but is still used for cmp/sha/tex nodes, + /* XXX this should not be necessary, but is still used for compositor/shading/texture nodes, * which only store the ntree pointer. Should be fixed at some point! */ ntree->execdata = exec; diff --git a/source/blender/python/bmesh/bmesh_py_types.c b/source/blender/python/bmesh/bmesh_py_types.c index d592a583817..169613999cd 100644 --- a/source/blender/python/bmesh/bmesh_py_types.c +++ b/source/blender/python/bmesh/bmesh_py_types.c @@ -4273,7 +4273,7 @@ char *BPy_BMElem_StringFromHType(const char htype) /* -------------------------------------------------------------------- */ /* keep at bottom */ -/* this function is called on free, it should stay quite fast */ +/* This function is called on free, it should stay quite fast */ static void bm_dealloc_editmode_warn(BPy_BMesh *self) { if (self->flag & BPY_BMFLAG_IS_WRAPPED) { diff --git a/source/blender/python/intern/bpy_app.c b/source/blender/python/intern/bpy_app.c index a0129157b95..70cf231bc26 100644 --- a/source/blender/python/intern/bpy_app.c +++ b/source/blender/python/intern/bpy_app.c @@ -559,7 +559,7 @@ PyObject *BPY_app_struct(void) BlenderAppType.tp_hash = (hashfunc) _Py_HashPointer; /* without this we can't do set(sys.modules) T29635. */ - /* kindof a hack ontop of PyStructSequence */ + /* Kind of a hack on top of #PyStructSequence. */ py_struct_seq_getset_init(); py_struct_seq_method_init(); diff --git a/source/blender/python/intern/bpy_library_load.c b/source/blender/python/intern/bpy_library_load.c index 9754599eeed..f29a8d34359 100644 --- a/source/blender/python/intern/bpy_library_load.c +++ b/source/blender/python/intern/bpy_library_load.c @@ -108,7 +108,7 @@ static PyTypeObject bpy_lib_Type = { NULL, /* ternaryfunc tp_call; */ NULL, /* reprfunc tp_str; */ - /* will only use these if this is a subtype of a py class */ + /* Will only use these if this is a sub-type of a Python class. */ PyObject_GenericGetAttr, /* getattrofunc tp_getattro; */ NULL, /* setattrofunc tp_setattro; */ diff --git a/source/blender/python/intern/bpy_rna.c b/source/blender/python/intern/bpy_rna.c index 941e0adfc1d..f6e8f2f88ec 100644 --- a/source/blender/python/intern/bpy_rna.c +++ b/source/blender/python/intern/bpy_rna.c @@ -1397,7 +1397,7 @@ PyObject *pyrna_prop_to_py(PointerRNA *ptr, PropertyRNA *prop) buf = RNA_property_string_get_alloc(ptr, prop, buf_fixed, sizeof(buf_fixed), &buf_len); #ifdef USE_STRING_COERCE - /* Only file paths get special treatment, they may contain non utf-8 chars. */ + /* Only file paths get special treatment, they may contain non UTF-8 chars. */ if (subtype == PROP_BYTESTRING) { ret = PyBytes_FromStringAndSize(buf, buf_len); } @@ -6487,7 +6487,7 @@ static PyObject *pyrna_func_doc_get(BPy_FunctionRNA *self, void *UNUSED(closure) PyTypeObject pyrna_struct_meta_idprop_Type = { PyVarObject_HEAD_INIT(NULL, 0) "bpy_struct_meta_idprop", /* tp_name */ - /* NOTE: would be PyTypeObject, but subtypes of Type must be PyHeapTypeObject's. */ + /* NOTE: would be PyTypeObject, but sub-types of Type must be PyHeapTypeObject's. */ sizeof(PyHeapTypeObject), /* tp_basicsize */ 0, /* tp_itemsize */ @@ -7308,7 +7308,7 @@ static PyObject *pyrna_srna_PyBase(StructRNA *srna) //, PyObject *bpy_types_dic if (base && base != srna) { // printf("debug subtype %s %p\n", RNA_struct_identifier(srna), srna); py_base = pyrna_srna_Subtype(base); //, bpy_types_dict); - Py_DECREF(py_base); /* Srna owns, this is only to pass as an arg. */ + Py_DECREF(py_base); /* `srna` owns, this is only to pass as an argument. */ } if (py_base == NULL) { @@ -8846,7 +8846,7 @@ static void bpy_class_free(void *pyob_ptr) } /** - * \note This isn't essential to run on startup, since subtypes will lazy initialize. + * \note This isn't essential to run on startup, since sub-types will lazy initialize. * But keep running in debug mode so we get immediate notification of bad class hierarchy * or any errors in "bpy_types.py" at load time, so errors don't go unnoticed. */ diff --git a/source/blender/python/intern/bpy_rna.h b/source/blender/python/intern/bpy_rna.h index 91fa0ea2c8d..d7778da6213 100644 --- a/source/blender/python/intern/bpy_rna.h +++ b/source/blender/python/intern/bpy_rna.h @@ -218,11 +218,13 @@ void pyrna_struct_type_extend_capi(struct StructRNA *srna, struct PyMethodDef *py_method, struct PyGetSetDef *py_getset); -/* called before stopping python */ +/* Called before stopping Python. */ + void pyrna_alloc_types(void); void pyrna_free_types(void); -/* primitive type conversion */ +/* Primitive type conversion. */ + int pyrna_py_to_array( PointerRNA *ptr, PropertyRNA *prop, char *param_data, PyObject *py, const char *error_prefix); int pyrna_py_to_array_index(PointerRNA *ptr, diff --git a/source/blender/python/intern/bpy_rna_data.c b/source/blender/python/intern/bpy_rna_data.c index cc0b4aa57d5..a3e865f4846 100644 --- a/source/blender/python/intern/bpy_rna_data.c +++ b/source/blender/python/intern/bpy_rna_data.c @@ -86,7 +86,7 @@ static PyTypeObject bpy_rna_data_context_Type = { NULL, /* ternaryfunc tp_call; */ NULL, /* reprfunc tp_str; */ - /* will only use these if this is a subtype of a py class */ + /* Will only use these if this is a sub-type of a Python class. */ NULL, /* getattrofunc tp_getattro; */ NULL, /* setattrofunc tp_setattro; */ diff --git a/source/blender/python/intern/bpy_traceback.c b/source/blender/python/intern/bpy_traceback.c index 1f2458c752f..428263fd4c4 100644 --- a/source/blender/python/intern/bpy_traceback.c +++ b/source/blender/python/intern/bpy_traceback.c @@ -25,7 +25,7 @@ static const char *traceback_filepath(PyTracebackObject *tb, PyObject **coerce) return PyBytes_AS_STRING(*coerce); } -/* copied from pythonrun.c, 3.10.0 */ +/* Copied from `pythonrun.c`, 3.10.0 */ _Py_static_string(PyId_string, "<string>"); static int parse_syntax_error(PyObject *err, diff --git a/source/blender/python/mathutils/mathutils.c b/source/blender/python/mathutils/mathutils.c index dcb6d7f3bc6..7cba95a1f85 100644 --- a/source/blender/python/mathutils/mathutils.c +++ b/source/blender/python/mathutils/mathutils.c @@ -710,7 +710,7 @@ void BaseMathObject_dealloc(BaseMathObject *self) BaseMathObject_clear(self); } - Py_TYPE(self)->tp_free(self); // PyObject_DEL(self); /* breaks subtypes. */ + Py_TYPE(self)->tp_free(self); // PyObject_DEL(self); /* breaks sub-types. */ } /*----------------------------MODULE INIT-------------------------*/ diff --git a/source/blender/python/mathutils/mathutils.h b/source/blender/python/mathutils/mathutils.h index 84386e99d18..7115c55b1c6 100644 --- a/source/blender/python/mathutils/mathutils.h +++ b/source/blender/python/mathutils/mathutils.h @@ -45,7 +45,7 @@ enum { PyObject *cb_user; \ /** Which user funcs do we adhere to, RNA, etc */ \ unsigned char cb_type; \ - /** Subtype: location, rotation... \ + /** Sub-type: location, rotation... \ * to avoid defining many new functions for every attribute of the same type */ \ unsigned char cb_subtype; \ /** Wrapped data type. */ \ diff --git a/source/blender/sequencer/intern/modifier.c b/source/blender/sequencer/intern/modifier.c index b17db8f762e..f324c6dba72 100644 --- a/source/blender/sequencer/intern/modifier.c +++ b/source/blender/sequencer/intern/modifier.c @@ -1177,7 +1177,7 @@ typedef struct AvgLogLum { static void tonemapmodifier_init_data(SequenceModifierData *smd) { SequencerTonemapModifierData *tmmd = (SequencerTonemapModifierData *)smd; - /* Same as tonemap compositor node. */ + /* Same as tone-map compositor node. */ tmmd->type = SEQ_TONEMAP_RD_PHOTORECEPTOR; tmmd->key = 0.18f; tmmd->offset = 1.0f; diff --git a/source/blender/sequencer/intern/render.c b/source/blender/sequencer/intern/render.c index ea9090addf5..eff0f0b17e9 100644 --- a/source/blender/sequencer/intern/render.c +++ b/source/blender/sequencer/intern/render.c @@ -1352,7 +1352,7 @@ static ImBuf *seq_render_scene_strip(const SeqRenderData *context, * find render). * However, when called from within the UI (image preview in sequencer) * we do want to use scene Render, that way the render result is defined - * for display in render/imagewindow + * for display in render/image-window * * Hmm, don't see, why we can't do that all the time, * and since G.is_rendering is uhm, gone... (Peter) diff --git a/source/blender/sequencer/intern/strip_edit.c b/source/blender/sequencer/intern/strip_edit.c index c35138b280a..7358f5e74a0 100644 --- a/source/blender/sequencer/intern/strip_edit.c +++ b/source/blender/sequencer/intern/strip_edit.c @@ -260,7 +260,7 @@ bool SEQ_edit_move_strip_to_meta(Scene *scene, static void seq_split_set_left_hold_offset(Scene *scene, Sequence *seq, int timeline_frame) { - /* Adjust within range of extended stillframes before strip. */ + /* Adjust within range of extended still-frames before strip. */ if (timeline_frame < seq->start) { seq->start = timeline_frame - 1; seq->anim_endofs += SEQ_time_strip_length_get(scene, seq) - 1; @@ -274,7 +274,7 @@ static void seq_split_set_left_hold_offset(Scene *scene, Sequence *seq, int time seq->endstill = 0; seq->anim_endofs += (seq->start + SEQ_time_strip_length_get(scene, seq)) - timeline_frame; } - /* Adjust within range of extended stillframes after strip. */ + /* Adjust within range of extended still-frames after strip. */ else if ((seq->start + SEQ_time_strip_length_get(scene, seq)) < timeline_frame) { seq->endstill = timeline_frame - seq->start - SEQ_time_strip_length_get(scene, seq); } @@ -282,7 +282,7 @@ static void seq_split_set_left_hold_offset(Scene *scene, Sequence *seq, int time static void seq_split_set_right_hold_offset(Scene *scene, Sequence *seq, int timeline_frame) { - /* Adjust within range of extended stillframes before strip. */ + /* Adjust within range of extended still-frames before strip. */ if (timeline_frame < seq->start) { seq->startstill = seq->start - timeline_frame; } @@ -294,7 +294,7 @@ static void seq_split_set_right_hold_offset(Scene *scene, Sequence *seq, int tim seq->startstill = 0; seq->startofs = 0; } - /* Adjust within range of extended stillframes after strip. */ + /* Adjust within range of extended still-frames after strip. */ else if ((seq->start + SEQ_time_strip_length_get(scene, seq)) < timeline_frame) { seq->start = timeline_frame; seq->startofs = 0; diff --git a/source/blender/windowmanager/gizmo/intern/wm_gizmo_group.c b/source/blender/windowmanager/gizmo/intern/wm_gizmo_group.c index e165cb6b4f8..1c0f1e03a47 100644 --- a/source/blender/windowmanager/gizmo/intern/wm_gizmo_group.c +++ b/source/blender/windowmanager/gizmo/intern/wm_gizmo_group.c @@ -632,7 +632,7 @@ wmKeyMap *wm_gizmogroup_tweak_modal_keymap(wmKeyConfig *keyconf) STRNCPY(name, "Generic Gizmo Tweak Modal Map"); keymap = WM_modalkeymap_find(keyconf, name); - /* this function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return NULL; } diff --git a/source/blender/windowmanager/intern/wm_event_system.cc b/source/blender/windowmanager/intern/wm_event_system.cc index 5f7a6078328..4209e1e5e00 100644 --- a/source/blender/windowmanager/intern/wm_event_system.cc +++ b/source/blender/windowmanager/intern/wm_event_system.cc @@ -4082,9 +4082,9 @@ void WM_event_fileselect_event(wmWindowManager *wm, void *ophandle, int eventval * An appropriate window is either of the following: * * A parent window that does not yet contain a modal File Browser. This is determined using * #ED_fileselect_handler_area_find_any_with_op(). - * * A parent window containing a modal File Browser, but in a maximized/fullscreen state. Users + * * A parent window containing a modal File Browser, but in a maximized/full-screen state. Users * shouldn't be able to put a temporary screen like the modal File Browser into - * maximized/fullscreen state themselves. So this setup indicates that the File Browser was + * maximized/full-screen state themselves. So this setup indicates that the File Browser was * opened using #USER_TEMP_SPACE_DISPLAY_FULLSCREEN. * * If no appropriate parent window can be found from the context window, return the first diff --git a/source/blender/windowmanager/intern/wm_operators.c b/source/blender/windowmanager/intern/wm_operators.c index 18b5461383f..259730513be 100644 --- a/source/blender/windowmanager/intern/wm_operators.c +++ b/source/blender/windowmanager/intern/wm_operators.c @@ -3673,7 +3673,7 @@ static void WM_OT_doc_view_manual_ui_context(wmOperatorType *ot) /* -------------------------------------------------------------------- */ /** \name Toggle Stereo 3D Operator * - * Turning it fullscreen if needed. + * Turning it full-screen if needed. * \{ */ static void WM_OT_stereo3d_set(wmOperatorType *ot) @@ -3805,7 +3805,7 @@ static void gesture_circle_modal_keymap(wmKeyConfig *keyconf) /* WARNING: Name is incorrect, use for non-3d views. */ wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "View3D Gesture Circle"); - /* this function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return; } @@ -3838,7 +3838,7 @@ static void gesture_straightline_modal_keymap(wmKeyConfig *keyconf) wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "Gesture Straight Line"); - /* this function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return; } @@ -3867,7 +3867,7 @@ static void gesture_box_modal_keymap(wmKeyConfig *keyconf) wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "Gesture Box"); - /* this function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return; } @@ -3920,7 +3920,7 @@ static void gesture_lasso_modal_keymap(wmKeyConfig *keyconf) wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "Gesture Lasso"); - /* this function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return; } @@ -3955,7 +3955,7 @@ static void gesture_zoom_border_modal_keymap(wmKeyConfig *keyconf) wmKeyMap *keymap = WM_modalkeymap_find(keyconf, "Gesture Zoom Border"); - /* this function is called for each spacetype, only needs to add map once */ + /* This function is called for each space-type, only needs to add map once. */ if (keymap && keymap->modal_items) { return; } diff --git a/source/blender/windowmanager/intern/wm_playanim.c b/source/blender/windowmanager/intern/wm_playanim.c index 60f3842bc7c..7c6650922a4 100644 --- a/source/blender/windowmanager/intern/wm_playanim.c +++ b/source/blender/windowmanager/intern/wm_playanim.c @@ -1353,7 +1353,7 @@ static void playanim_window_open(const char *title, int posx, int posy, int size posy, sizex, sizey, - /* could optionally start fullscreen */ + /* Could optionally start full-screen. */ GHOST_kWindowStateNormal, false, GHOST_kDrawingContextTypeOpenGL, diff --git a/source/blender/windowmanager/intern/wm_window.c b/source/blender/windowmanager/intern/wm_window.c index b428fd65e7f..d2339d7efad 100644 --- a/source/blender/windowmanager/intern/wm_window.c +++ b/source/blender/windowmanager/intern/wm_window.c @@ -1281,7 +1281,7 @@ static bool ghost_event_proc(GHOST_EventHandle evt, GHOST_TUserDataPtr C_void_pt state_str = "maximized"; } else if (state == GHOST_kWindowStateFullScreen) { - state_str = "fullscreen"; + state_str = "full-screen"; } else { state_str = "<unknown>"; |