Cleanup: spelling in comments

Also move mis-placed doc-string.
This commit is contained in:
Campbell Barton 2022-07-08 09:10:30 +10:00
parent 9ef3736959
commit 03173d63c0
9 changed files with 25 additions and 18 deletions

View File

@ -908,12 +908,12 @@ static FT_GlyphSlot blf_glyph_render(FontBLF *settings_font,
bool spacing_done = false;
/* 70% of maximum weight results in the same amount of boldness and horizontal
* expansion as the bold version (DejaVuSans-Bold.ttf) of our default font.
* expansion as the bold version `DejaVuSans-Bold.ttf` of our default font.
* Worth reevaluating if we change default font. */
float weight = (settings_font->flags & BLF_BOLD) ? 0.7f : settings_font->char_weight;
/* 37.5% of maximum rightward slant results in 6 degree slope, matching italic
* version (DejaVuSans-Oblique.ttf) of our current font. But a nice median when
* version `DejaVuSans-Oblique.ttf` of our current font. But a nice median when
* checking others. Worth reevaluating if we change default font. We could also
* narrow the glyph slightly as most italics do, but this one does not. */
float slant = (settings_font->flags & BLF_ITALIC) ? 0.375f : settings_font->char_slant;

View File

@ -159,7 +159,7 @@ struct BoundBox *BKE_armature_boundbox_get(struct Object *ob);
* Visual elements such as the envelopes radius & bendy-bone spline segments are *not* included,
* making this not so useful for viewport culling.
*
* \param use_empty_drawtype: When enabled, the draw type of empty custom-objects is tagen into
* \param use_empty_drawtype: When enabled, the draw type of empty custom-objects is taken into
* account when calculating the bounds.
*/
void BKE_pchan_minmax(const struct Object *ob,

View File

@ -75,7 +75,8 @@ float *BKE_mball_make_orco(struct Object *ob, struct ListBase *dispbase);
* When some properties (wire-size, threshold, update flags) of meta-ball are changed, then this
* properties are copied to all meta-balls in same "group" (meta-balls with same base name:
* `MBall`, `MBall.001`, `MBall.002`, etc). The most important is to copy properties to the base
* meta-ball, because this meta-ball influences polygonization of meta-balls. */
* meta-ball, because this meta-ball influences polygonization of meta-balls.
*/
void BKE_mball_properties_copy(struct Main *bmain, struct MetaBall *active_metaball);
bool BKE_mball_minmax_ex(

View File

@ -366,9 +366,6 @@ void BKE_object_empty_draw_type_set(struct Object *ob, int value);
void BKE_object_boundbox_calc_from_mesh(struct Object *ob, const struct Mesh *me_eval);
bool BKE_object_boundbox_calc_from_evaluated_geometry(struct Object *ob);
/**
* Calculate visual bounds from an empty objects draw-type.
*/
void BKE_object_minmax(struct Object *ob, float r_min[3], float r_max[3], bool use_hidden);
bool BKE_object_minmax_dupli(struct Depsgraph *depsgraph,
struct Scene *scene,
@ -376,6 +373,12 @@ bool BKE_object_minmax_dupli(struct Depsgraph *depsgraph,
float r_min[3],
float r_max[3],
bool use_hidden);
/**
* Calculate visual bounds from an empty objects draw-type.
*
* \note This is not part of the calculation used by #BKE_object_boundbox_get
* as these bounds represent the extents of visual guides (use for viewport culling for e.g.)
*/
bool BKE_object_minmax_empty_drawtype(const struct Object *ob, float r_min[3], float r_max[3]);
/**

View File

@ -290,7 +290,7 @@ static void image_save_post(ReportList *reports,
BLI_strncpy(ibuf->name, filepath, sizeof(ibuf->name));
}
/* The tiled image codepath must call this on its own. */
/* The tiled image code-path must call this on its own. */
if (ima->source != IMA_SRC_TILED) {
image_save_update_filepath(ima, filepath, opts);
}

View File

@ -434,13 +434,16 @@ static void mball_data_properties_copy(MetaBall *mb_dst, MetaBall *mb_src)
void BKE_mball_properties_copy(Main *bmain, MetaBall *metaball_src)
{
/* WARNING: This code does not cover all potential corner-cases. E.g. if:
* | Object | ObData |
* | ---------- | ---------- |
* | Meta_A | Meta_A |
* | Meta_A.001 | Meta_A.001 |
* | Meta_B | Meta_A |
* | Meta_B.001 | Meta_B.001 |
/**
* WARNING: This code does not cover all potential corner-cases. E.g. if:
* <pre>
* | Object | ObData |
* | ---------- | ---------- |
* | Meta_A | Meta_A |
* | Meta_A.001 | Meta_A.001 |
* | Meta_B | Meta_A |
* | Meta_B.001 | Meta_B.001 |
* </pre>
*
* Calling this function with `metaball_src` being `Meta_A.001` will update `Meta_A`, but NOT
* `Meta_B.001`. So in the 'Meta_B' family, the two metaballs will have unmatching settings now.

View File

@ -199,7 +199,7 @@ static ImageUser *image_user_from_context(const bContext *C)
static ImageUser image_user_from_context_and_active_tile(const bContext *C, Image *ima)
{
/* Try to get image user from contexrt if available, otherwise use default. */
/* Try to get image user from context if available, otherwise use default. */
ImageUser *iuser_context = image_user_from_context(C);
ImageUser iuser;
if (iuser_context) {

View File

@ -240,7 +240,7 @@ typedef struct wmWindow {
/** Active view layer displayed in this window. */
char view_layer_name[64];
/** The workspace may temporarily override the window's scene with scene pinning. This is the
* "overriden" or "default" scene to restore when entering a workspace with no scene pinned. */
* "overridden" or "default" scene to restore when entering a workspace with no scene pinned. */
struct Scene *unpinned_scene;
struct WorkSpaceInstanceHook *workspace_hook;

View File

@ -275,7 +275,7 @@ void BPY_driver_reset(void)
}
/**
* Error return function for #BPY_eval_pydriver.
* Error return function for #BPY_driver_exec.
*
* \param anim_rna: Used to show the target when printing the error to give additional context.
*/