Cleanup: spelling in comments

This commit is contained in:
Campbell Barton 2023-04-16 16:24:38 +10:00
parent cffc9bdb93
commit 8afb8db66e
17 changed files with 76 additions and 75 deletions

@ -592,8 +592,8 @@ bGPDframe *BKE_gpencil_frame_addcopy(bGPDlayer *gpl, int cframe)
break;
}
if (gpf->framenum == cframe) {
/* This only happens when we're editing with framelock on...
* - Delete the new frame and don't do anything else here...
/* This only happens when we're editing with frame-lock on.
* - Delete the new frame and don't do anything else here.
*/
BKE_gpencil_free_strokes(new_frame);
MEM_freeN(new_frame);

@ -2457,7 +2457,7 @@ static int annotation_draw_modal(bContext *C, wmOperator *op, const wmEvent *eve
}
/* We don't pass on key events, GP is used with key-modifiers -
* prevents Dkey to insert drivers. */
* prevents D-key to insert drivers. */
if (ISKEYBOARD(event->type)) {
if (ELEM(event->type,
EVT_LEFTARROWKEY,

@ -188,7 +188,7 @@ static void gpencil_draw_stroke_3d(tGPDdraw *tgpw,
int keep_size = (int)((tgpw->gpd) && (tgpw->gpd->flag & GP_DATA_STROKE_KEEPTHICKNESS));
gpencil_stroke_data.keep_size = keep_size;
gpencil_stroke_data.pixfactor = tgpw->gpd->pixfactor;
/* xray mode always to 3D space to avoid wrong zdepth calculation (#60051) */
/* X-ray mode always to 3D space to avoid wrong Z-depth calculation (#60051). */
gpencil_stroke_data.xraymode = GP_XRAY_3DSPACE;
gpencil_stroke_data.caps_start = tgpw->gps->caps[0];
gpencil_stroke_data.caps_end = tgpw->gps->caps[1];

@ -193,7 +193,7 @@ static int gpencil_editmode_toggle_exec(bContext *C, wmOperator *op)
ob->mode = mode;
}
/* Recalculate editcurves for strokes where the geometry/vertex colors have changed */
/* Recalculate edit-curves for strokes where the geometry/vertex colors have changed. */
if (GPENCIL_CURVE_EDIT_SESSIONS_ON(gpd)) {
GP_EDITABLE_CURVES_BEGIN(gps_iter, C, gpl, gps, gpc)
{
@ -1410,9 +1410,8 @@ void ED_gpencil_strokes_copybuf_free(void)
{
bGPDstroke *gps, *gpsn;
/* Free the colors buffer
* NOTE: This is done before the strokes so that the ptrs are still safe
*/
/* Free the colors buffer.
* NOTE: This is done before the strokes so that the pointers are still safe. */
if (gpencil_strokes_copypastebuf_colors) {
BLI_ghash_free(gpencil_strokes_copypastebuf_colors, NULL, MEM_freeN);
gpencil_strokes_copypastebuf_colors = NULL;

@ -715,7 +715,7 @@ static void gpencil_update_extensions_line(tGPDfill *tgpf)
}
}
/* Cut overlength strokes. */
/* Cut over-length strokes. */
gpencil_cut_extensions(tgpf);
}

@ -1371,7 +1371,7 @@ static int gpencil_interpolate_seq_exec(bContext *C, wmOperator *op)
float factor = (float)(cframe - prevFrame->framenum) / framerange;
if (type == GP_IPO_CURVEMAP) {
/* custom curvemap */
/* Custom curve-map. */
if (ipo_settings->custom_ipo) {
factor = BKE_curvemapping_evaluateF(ipo_settings->custom_ipo, 0, factor);
}

@ -1324,7 +1324,7 @@ static void gpencil_sculpt_brush_exit(bContext *C, wmOperator *op)
BLI_ghash_free(gso->automasking_strokes, NULL, NULL);
}
/* Disable headerprints. */
/* Clear status-bar text. */
ED_workspace_status_text(C, NULL);
/* disable temp invert flag */
@ -2320,21 +2320,21 @@ static int gpencil_sculpt_brush_modal(bContext *C, wmOperator *op, const wmEvent
bool redraw_region = false;
bool redraw_toolsettings = false;
/* The operator can be in 2 states: Painting and Idling */
/* The operator can be in 2 states: Painting and Idling. */
if (gso->is_painting) {
/* Painting. */
switch (event->type) {
/* Mouse Move = Apply somewhere else */
/* Mouse Move: Apply somewhere else. */
case MOUSEMOVE:
case INBETWEEN_MOUSEMOVE:
/* apply brush effect at new position */
/* apply brush effect at new position. */
gpencil_sculpt_brush_apply_event(C, op, event);
/* force redraw, so that the cursor will at least be valid */
/* force redraw, so that the cursor will at least be valid. */
redraw_region = true;
break;
/* Timer Tick - Only if this was our own timer */
/* Timer Tick - Only if this was our own timer. */
case TIMER:
if (event->customdata == gso->timer) {
gso->timerTick = true;
@ -2343,7 +2343,7 @@ static int gpencil_sculpt_brush_modal(bContext *C, wmOperator *op, const wmEvent
}
break;
/* Painting mbut release = Stop painting (back to idle) */
/* Painting mouse-button release: Stop painting (back to idle). */
case LEFTMOUSE:
// BLI_assert(event->val == KM_RELEASE);
if (is_modal) {
@ -2351,7 +2351,7 @@ static int gpencil_sculpt_brush_modal(bContext *C, wmOperator *op, const wmEvent
gso->is_painting = false;
}
else {
/* end sculpt session, since we're not modal */
/* end sculpt session, since we're not modal. */
gso->is_painting = false;
gpencil_sculpt_brush_exit(C, op);
@ -2359,7 +2359,7 @@ static int gpencil_sculpt_brush_modal(bContext *C, wmOperator *op, const wmEvent
}
break;
/* Abort painting if any of the usual things are tried */
/* Abort painting if any of the usual things are tried. */
case MIDDLEMOUSE:
case RIGHTMOUSE:
case EVT_ESCKEY:
@ -2368,13 +2368,13 @@ static int gpencil_sculpt_brush_modal(bContext *C, wmOperator *op, const wmEvent
}
}
else {
/* Idling */
/* Idling. */
BLI_assert(is_modal == true);
switch (event->type) {
/* Painting mbut press = Start painting (switch to painting state) */
/* Painting mouse-button press: Start painting (switch to painting state). */
case LEFTMOUSE:
/* do initial "click" apply */
/* do initial "click" apply. */
gso->is_painting = true;
gso->first = true;
@ -2382,30 +2382,30 @@ static int gpencil_sculpt_brush_modal(bContext *C, wmOperator *op, const wmEvent
gpencil_sculpt_brush_apply_event(C, op, event);
break;
/* Exit modal operator, based on the "standard" ops */
/* Exit modal operator, based on the "standard" ops. */
case RIGHTMOUSE:
case EVT_ESCKEY:
gpencil_sculpt_brush_exit(C, op);
return OPERATOR_FINISHED;
/* MMB is often used for view manipulations */
/* MMB is often used for view manipulations. */
case MIDDLEMOUSE:
return OPERATOR_PASS_THROUGH;
/* Mouse movements should update the brush cursor - Just redraw the active region */
/* Mouse movements should update the brush cursor - Just redraw the active region. */
case MOUSEMOVE:
case INBETWEEN_MOUSEMOVE:
redraw_region = true;
break;
/* Change Frame - Allowed */
/* Change Frame - Allowed. */
case EVT_LEFTARROWKEY:
case EVT_RIGHTARROWKEY:
case EVT_UPARROWKEY:
case EVT_DOWNARROWKEY:
return OPERATOR_PASS_THROUGH;
/* Camera/View Gizmo's - Allowed */
/* Camera/View Gizmo's - Allowed. */
/* (See rationale in gpencil_paint.c -> gpencil_draw_modal()) */
case EVT_PAD0:
case EVT_PAD1:
@ -2419,7 +2419,7 @@ static int gpencil_sculpt_brush_modal(bContext *C, wmOperator *op, const wmEvent
case EVT_PAD9:
return OPERATOR_PASS_THROUGH;
/* Unhandled event */
/* Unhandled event. */
default:
break;
}

@ -761,7 +761,7 @@ static void gpencil_vertexpaint_brush_exit(bContext *C, wmOperator *op)
{
tGP_BrushVertexpaintData *gso = op->customdata;
/* Disable headerprints. */
/* Clear status-bar text. */
ED_workspace_status_text(C, NULL);
/* Disable temp invert flag. */
@ -1318,28 +1318,28 @@ static int gpencil_vertexpaint_brush_modal(bContext *C, wmOperator *op, const wm
bool redraw_region = false;
bool redraw_toolsettings = false;
/* The operator can be in 2 states: Painting and Idling */
/* The operator can be in 2 states: Painting and Idling. */
if (gso->is_painting) {
/* Painting. */
switch (event->type) {
/* Mouse Move = Apply somewhere else */
/* Mouse Move: Apply somewhere else. */
case MOUSEMOVE:
case INBETWEEN_MOUSEMOVE:
/* apply brush effect at new position */
/* Apply brush effect at new position. */
gpencil_vertexpaint_brush_apply_event(C, op, event);
/* force redraw, so that the cursor will at least be valid */
/* Force redraw, so that the cursor will at least be valid. */
redraw_region = true;
break;
/* Painting mbut release = Stop painting (back to idle) */
/* Painting mouse-button release means: Stop painting (back to idle). */
case LEFTMOUSE:
if (is_modal) {
/* go back to idling... */
gso->is_painting = false;
}
else {
/* end painting, since we're not modal */
/* end painting, since we're not modal. */
gso->is_painting = false;
gpencil_vertexpaint_brush_exit(C, op);
@ -1347,7 +1347,7 @@ static int gpencil_vertexpaint_brush_modal(bContext *C, wmOperator *op, const wm
}
break;
/* Abort painting if any of the usual things are tried */
/* Abort painting if any of the usual things are tried. */
case MIDDLEMOUSE:
case RIGHTMOUSE:
case EVT_ESCKEY:
@ -1356,43 +1356,43 @@ static int gpencil_vertexpaint_brush_modal(bContext *C, wmOperator *op, const wm
}
}
else {
/* Idling */
/* Idling. */
BLI_assert(is_modal == true);
switch (event->type) {
/* Painting mbut press = Start painting (switch to painting state) */
/* Painting mouse-button press means: Start painting (switch to painting state). */
case LEFTMOUSE:
/* do initial "click" apply */
/* do initial "click" apply. */
gso->is_painting = true;
gso->first = true;
gpencil_vertexpaint_brush_apply_event(C, op, event);
break;
/* Exit modal operator, based on the "standard" ops */
/* Exit modal operator, based on the "standard" ops. */
case RIGHTMOUSE:
case EVT_ESCKEY:
gpencil_vertexpaint_brush_exit(C, op);
return OPERATOR_FINISHED;
/* MMB is often used for view manipulations */
/* MMB is often used for view manipulations. */
case MIDDLEMOUSE:
return OPERATOR_PASS_THROUGH;
/* Mouse movements should update the brush cursor - Just redraw the active region */
/* Mouse movements should update the brush cursor - Just redraw the active region. */
case MOUSEMOVE:
case INBETWEEN_MOUSEMOVE:
redraw_region = true;
break;
/* Change Frame - Allowed */
/* Change Frame - Allowed. */
case EVT_LEFTARROWKEY:
case EVT_RIGHTARROWKEY:
case EVT_UPARROWKEY:
case EVT_DOWNARROWKEY:
return OPERATOR_PASS_THROUGH;
/* Camera/View Gizmo's - Allowed */
/* Camera/View Gizmo's - Allowed. */
/* (See rationale in gpencil_paint.c -> gpencil_draw_modal()) */
case EVT_PAD0:
case EVT_PAD1:
@ -1406,7 +1406,7 @@ static int gpencil_vertexpaint_brush_modal(bContext *C, wmOperator *op, const wm
case EVT_PAD9:
return OPERATOR_PASS_THROUGH;
/* Unhandled event */
/* Unhandled event. */
default:
break;
}

@ -345,7 +345,7 @@ static void gpencil_weightpaint_brush_exit(bContext *C, wmOperator *op)
{
tGP_BrushWeightpaintData *gso = op->customdata;
/* Disable headerprints. */
/* Clear status bar text. */
ED_workspace_status_text(C, NULL);
/* Free operator data */
@ -767,7 +767,7 @@ static int gpencil_weightpaint_brush_invoke(bContext *C, wmOperator *op, const w
return OPERATOR_RUNNING_MODAL;
}
/* painting - handle events */
/* painting - handle events. */
static int gpencil_weightpaint_brush_modal(bContext *C, wmOperator *op, const wmEvent *event)
{
tGP_BrushWeightpaintData *gso = op->customdata;
@ -775,28 +775,28 @@ static int gpencil_weightpaint_brush_modal(bContext *C, wmOperator *op, const wm
bool redraw_region = false;
bool redraw_toolsettings = false;
/* The operator can be in 2 states: Painting and Idling */
/* The operator can be in 2 states: Painting and Idling. */
if (gso->is_painting) {
/* Painting. */
switch (event->type) {
/* Mouse Move = Apply somewhere else */
/* Mouse Move: Apply somewhere else. */
case MOUSEMOVE:
case INBETWEEN_MOUSEMOVE:
/* apply brush effect at new position */
/* Apply brush effect at new position. */
gpencil_weightpaint_brush_apply_event(C, op, event);
/* force redraw, so that the cursor will at least be valid */
/* Force redraw, so that the cursor will at least be valid. */
redraw_region = true;
break;
/* Painting mbut release = Stop painting (back to idle) */
/* Painting mouse-button release: Stop painting (back to idle). */
case LEFTMOUSE:
if (is_modal) {
/* go back to idling... */
gso->is_painting = false;
}
else {
/* end painting, since we're not modal */
/* end painting, since we're not modal. */
gso->is_painting = false;
gpencil_weightpaint_brush_exit(C, op);
@ -804,7 +804,7 @@ static int gpencil_weightpaint_brush_modal(bContext *C, wmOperator *op, const wm
}
break;
/* Abort painting if any of the usual things are tried */
/* Abort painting if any of the usual things are tried. */
case MIDDLEMOUSE:
case RIGHTMOUSE:
case EVT_ESCKEY:
@ -813,43 +813,43 @@ static int gpencil_weightpaint_brush_modal(bContext *C, wmOperator *op, const wm
}
}
else {
/* Idling */
/* Idling. */
BLI_assert(is_modal == true);
switch (event->type) {
/* Painting mbut press = Start painting (switch to painting state) */
/* Painting mouse-button press = Start painting (switch to painting state). */
case LEFTMOUSE:
/* do initial "click" apply */
/* do initial "click" apply. */
gso->is_painting = true;
gso->first = true;
gpencil_weightpaint_brush_apply_event(C, op, event);
break;
/* Exit modal operator, based on the "standard" ops */
/* Exit modal operator, based on the "standard" ops. */
case RIGHTMOUSE:
case EVT_ESCKEY:
gpencil_weightpaint_brush_exit(C, op);
return OPERATOR_FINISHED;
/* MMB is often used for view manipulations */
/* MMB is often used for view manipulations. */
case MIDDLEMOUSE:
return OPERATOR_PASS_THROUGH;
/* Mouse movements should update the brush cursor - Just redraw the active region */
/* Mouse movements should update the brush cursor - Just redraw the active region. */
case MOUSEMOVE:
case INBETWEEN_MOUSEMOVE:
redraw_region = true;
break;
/* Change Frame - Allowed */
/* Change Frame - Allowed. */
case EVT_LEFTARROWKEY:
case EVT_RIGHTARROWKEY:
case EVT_UPARROWKEY:
case EVT_DOWNARROWKEY:
return OPERATOR_PASS_THROUGH;
/* Camera/View Gizmo's - Allowed */
/* Camera/View Gizmo's - Allowed. */
/* (See rationale in gpencil_paint.c -> gpencil_draw_modal()) */
case EVT_PAD0:
case EVT_PAD1:
@ -863,7 +863,7 @@ static int gpencil_weightpaint_brush_modal(bContext *C, wmOperator *op, const wm
case EVT_PAD9:
return OPERATOR_PASS_THROUGH;
/* Unhandled event */
/* Unhandled event. */
default:
break;
}

@ -470,10 +470,10 @@ static int console_insert_invoke(bContext *C, wmOperator *op, const wmEvent *eve
/* NOTE: the "text" property is always set from key-map,
* so we can't use #RNA_struct_property_is_set, check the length instead. */
if (!RNA_string_length(op->ptr, "text")) {
/* if alt/ctrl/super are pressed pass through except for utf8 character event
* (when input method are used for utf8 inputs, the user may assign key event
* including alt/ctrl/super like ctrl+m to commit utf8 string. in such case,
* the modifiers in the utf8 character event make no sense.) */
/* If alt/control/super are pressed pass through except for UTF8 character event
* (when input method are used for UTF8 inputs, the user may assign key event
* including alt/control/super like control-m to commit UTF8 string.
* in such case, the modifiers in the UTF8 character event make no sense.) */
if ((event->modifier & (KM_CTRL | KM_OSKEY)) && !event->utf8_buf[0]) {
return OPERATOR_PASS_THROUGH;
}

@ -218,7 +218,7 @@ static void createTransGPencil_curves(bContext *C,
if (IS_AUTOKEY_ON(scene)) {
gpf = BKE_gpencil_frame_addcopy(gpl, cfra);
}
/* in some weird situations (framelock enabled) return NULL */
/* In some weird situations (frame-lock enabled) return NULL. */
if (gpf == NULL) {
continue;
}
@ -513,7 +513,7 @@ static void createTransGPencil_strokes(bContext *C,
if (IS_AUTOKEY_ON(scene)) {
gpf = BKE_gpencil_frame_addcopy(gpl, cfra);
}
/* in some weird situations (framelock enabled) return NULL */
/* In some weird situations (frame-lock enabled) return NULL. */
if (gpf == NULL) {
continue;
}

@ -164,7 +164,7 @@ static void generate_geometry(GpencilModifierData *md,
bGPdata *gpd = (bGPdata *)ob->data;
bool found = false;
/* Get bounbox for relative offset. */
/* Get bound-box for relative offset. */
float size[3] = {0.0f, 0.0f, 0.0f};
if (mmd->flag & GP_ARRAY_USE_RELATIVE) {
float min[3];

@ -61,7 +61,7 @@ static void copyData(const GpencilModifierData *md, GpencilModifierData *target)
BKE_gpencil_modifier_copydata_generic(md, target);
}
/* change stroke offsetness */
/* Change stroke offset. */
static void deformStroke(GpencilModifierData *md,
Depsgraph *UNUSED(depsgraph),
Object *ob,

@ -715,7 +715,7 @@ enum {
/**
* Long-life tags giving important info about general ID management.
*
* These tags are typically not chnaged often, if ever, during an ID's life.
* These tags are typically not changed often, if ever, during an ID's life.
*/
/**
@ -793,7 +793,7 @@ enum {
LIB_TAG_LIB_OVERRIDE_NEED_RESYNC = 1 << 8,
/**
* Short-life tags used during specific processes, like blendfile readind.
* Short-life tags used during specific processes, like blend-file reading.
*/
/**

@ -2548,7 +2548,7 @@ static void rna_def_modifier_gpencilbuild(BlenderRNA *brna)
RNA_def_property_ui_text(prop, "Time Alignment", "How should strokes start to appear/disappear");
RNA_def_property_update(prop, 0, "rna_GpencilModifier_update");
/* Which time mode to use: Current frames, manual percentage, or drawspeed. */
/* Which time mode to use: Current frames, manual percentage, or draw-speed. */
prop = RNA_def_property(srna, "time_mode", PROP_ENUM, PROP_NONE);
RNA_def_property_enum_sdna(prop, NULL, "time_mode");
RNA_def_property_enum_items(prop, gpencil_build_time_mode_items);

@ -1038,7 +1038,7 @@ static void rna_EnumProperty_items_begin(CollectionPropertyIterator *iter, Point
static void rna_EnumProperty_items_ui_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
{
/* No skip-funciton, include all "UI" items. */
/* No skip-function, include all "UI" items. */
rna_EnumProperty_items_begin_impl(iter, ptr, NULL);
}

@ -83,6 +83,7 @@ dict_custom = {
"deduplication",
"defocus",
"degeneracies",
"deletable",
"deleter",
"denoised",
"denoiser",
@ -187,6 +188,7 @@ dict_custom = {
"orthonormalized",
"overridable",
"paddings",
"paintable",
"pannable",
"parallelepiped",
"parallelize",