Cleanup: spelling

This commit is contained in:
2019-03-08 17:48:49 +11:00
parent 4185b3e36d
commit eb8e656b2b
17 changed files with 39 additions and 36 deletions

View File

@@ -54,7 +54,7 @@ static void covariance_m_vn_ex_task_cb(
int k; int k;
/* Covariance matrices are always symetrical, so we can compute only one half of it, /* Covariance matrices are always symmetrical, so we can compute only one half of it,
* and mirror it to the other half (at the end of the func). * and mirror it to the other half (at the end of the func).
* *
* This allows using a flat loop of n*n with same results as imbricated one over half the matrix: * This allows using a flat loop of n*n with same results as imbricated one over half the matrix:

View File

@@ -728,7 +728,7 @@ TaskPool *BLI_task_pool_create_background(TaskScheduler *scheduler, void *userda
/** /**
* Similar to BLI_task_pool_create() but does not schedule any tasks for execution * Similar to BLI_task_pool_create() but does not schedule any tasks for execution
* for until BLI_task_pool_work_and_wait() is called. This helps reducing therading * for until BLI_task_pool_work_and_wait() is called. This helps reducing threading
* overhead when pushing huge amount of small initial tasks from the main thread. * overhead when pushing huge amount of small initial tasks from the main thread.
*/ */
TaskPool *BLI_task_pool_create_suspended(TaskScheduler *scheduler, void *userdata) TaskPool *BLI_task_pool_create_suspended(TaskScheduler *scheduler, void *userdata)

View File

@@ -846,7 +846,7 @@ static int gizmo_cage2d_modal(
return OPERATOR_RUNNING_MODAL; return OPERATOR_RUNNING_MODAL;
} }
/* For transform logic to be manageable we operate in -0.5..0.5 2D space, /* For transform logic to be manageable we operate in -0.5..0.5 2D space,
* no matter the size of the rectangle, mouse coorts are scaled to unit space. * no matter the size of the rectangle, mouse coords are scaled to unit space.
* The mouse coords have been projected into the matrix so we don't need to worry about axis alignment. * The mouse coords have been projected into the matrix so we don't need to worry about axis alignment.
* *
* - The cursor offset are multiplied by 'dims'. * - The cursor offset are multiplied by 'dims'.

View File

@@ -1730,7 +1730,7 @@ void ED_gpencil_draw_view3d_object(wmWindowManager *wm, Scene *scene, Depsgraph
} }
if ((wm == NULL) || ED_screen_animation_playing(wm)) { if ((wm == NULL) || ED_screen_animation_playing(wm)) {
/* don't show onionskins during animation playback/scrub (i.e. it obscures the poses) /* don't show onion-skins during animation playback/scrub (i.e. it obscures the poses)
* OpenGL Renders (i.e. final output), or depth buffer (i.e. not real strokes) * OpenGL Renders (i.e. final output), or depth buffer (i.e. not real strokes)
*/ */
dflag |= GP_DRAWDATA_NO_ONIONS; dflag |= GP_DRAWDATA_NO_ONIONS;

View File

@@ -1350,9 +1350,10 @@ static void gp_free_stroke(bGPdata *gpd, bGPDframe *gpf, bGPDstroke *gps)
gp_update_cache(gpd); gp_update_cache(gpd);
} }
/* analyze points to be removed when soft eraser is used /**
* to avoid that segments gets the end points rounded. This * Analyze points to be removed when soft eraser is used
* round cpas breaks the artistic effect. * to avoid that segments gets the end points rounded.
* The round caps breaks the artistic effect.
*/ */
static void gp_stroke_soft_refine(bGPDstroke *gps, const float cull_thresh) static void gp_stroke_soft_refine(bGPDstroke *gps, const float cull_thresh)
{ {
@@ -2020,7 +2021,7 @@ static tGPsdata *gp_session_initpaint(bContext *C, wmOperator *op)
/* Create new context data */ /* Create new context data */
p = MEM_callocN(sizeof(tGPsdata), "GPencil Drawing Data"); p = MEM_callocN(sizeof(tGPsdata), "GPencil Drawing Data");
/* Try to initialise context data /* Try to initialize context data
* WARNING: This may not always succeed (e.g. using GP in an annotation-only context) * WARNING: This may not always succeed (e.g. using GP in an annotation-only context)
*/ */
if (gp_session_initdata(C, op, p) == 0) { if (gp_session_initdata(C, op, p) == 0) {

View File

@@ -100,8 +100,8 @@ static int cachefile_open_exec(bContext *C, wmOperator *op)
/* hook into UI */ /* hook into UI */
PropertyPointerRNA *pprop = op->customdata; PropertyPointerRNA *pprop = op->customdata;
if (pprop->prop) { if (pprop->prop) {
/* when creating new ID blocks, use is already 1, but RNA /* When creating new ID blocks, use is already 1, but RNA
* pointer se also increases user, so this compensates it */ * pointer see also increases user, so this compensates it. */
id_us_min(&cache_file->id); id_us_min(&cache_file->id);
PointerRNA idptr; PointerRNA idptr;

View File

@@ -3605,7 +3605,7 @@ void MESH_OT_select_less(wmOperatorType *ot)
* \{ */ * \{ */
/** /**
* Check if we're connected to another selected efge. * Check if we're connected to another selected edge.
*/ */
static bool bm_edge_is_select_isolated(BMEdge *e) static bool bm_edge_is_select_isolated(BMEdge *e)
{ {

View File

@@ -4163,8 +4163,8 @@ static int screen_animation_step(bContext *C, wmOperator *UNUSED(op), const wmEv
*/ */
ED_refresh_viewport_fps(C); ED_refresh_viewport_fps(C);
/* recalculate the timestep for the timer now that we've finished calculating this, /* Recalculate the time-step for the timer now that we've finished calculating this,
* since the frames-per-second value may have been changed * since the frames-per-second value may have been changed.
*/ */
/* TODO: this may make evaluation a bit slower if the value doesn't change... any way to avoid this? */ /* TODO: this may make evaluation a bit slower if the value doesn't change... any way to avoid this? */
wt->timestep = (1.0 / FPS); wt->timestep = (1.0 / FPS);

View File

@@ -1683,7 +1683,7 @@ static void do_wpaint_brush_blur_task_cb_ex(
{ {
/* Test to see if the vertex coordinates are within the spherical brush region. */ /* Test to see if the vertex coordinates are within the spherical brush region. */
if (sculpt_brush_test_sq_fn(&test, vd.co)) { if (sculpt_brush_test_sq_fn(&test, vd.co)) {
/* For grid based pbvh, take the vert whose loop coopresponds to the current grid. /* For grid based pbvh, take the vert whose loop corresponds to the current grid.
* Otherwise, take the current vert. */ * Otherwise, take the current vert. */
const int v_index = has_grids ? data->me->mloop[vd.grid_indices[vd.g]].v : vd.vert_indices[vd.i]; const int v_index = has_grids ? data->me->mloop[vd.grid_indices[vd.g]].v : vd.vert_indices[vd.i];
const float grid_alpha = has_grids ? 1.0f / vd.gridsize : 1.0f; const float grid_alpha = has_grids ? 1.0f / vd.gridsize : 1.0f;
@@ -1780,7 +1780,7 @@ static void do_wpaint_brush_smear_task_cb_ex(
{ {
/* Test to see if the vertex coordinates are within the spherical brush region. */ /* Test to see if the vertex coordinates are within the spherical brush region. */
if (sculpt_brush_test_sq_fn(&test, vd.co)) { if (sculpt_brush_test_sq_fn(&test, vd.co)) {
/* For grid based pbvh, take the vert whose loop cooresponds to the current grid. /* For grid based pbvh, take the vert whose loop corresponds to the current grid.
* Otherwise, take the current vert. */ * Otherwise, take the current vert. */
const int v_index = has_grids ? data->me->mloop[vd.grid_indices[vd.g]].v : vd.vert_indices[vd.i]; const int v_index = has_grids ? data->me->mloop[vd.grid_indices[vd.g]].v : vd.vert_indices[vd.i];
const float grid_alpha = has_grids ? 1.0f / vd.gridsize : 1.0f; const float grid_alpha = has_grids ? 1.0f / vd.gridsize : 1.0f;

View File

@@ -1611,15 +1611,15 @@ static void bmesh_four_neighbor_average(float avg[3], float direction[3], BMVert
return; return;
} }
/* Project the direction to the vertex normal and create an aditional /* Project the direction to the vertex normal and create an additional
* parallel vector. */ * parallel vector. */
float dir_a[3], dir_b[3]; float dir_a[3], dir_b[3];
cross_v3_v3v3(dir_a, direction, v->no); cross_v3_v3v3(dir_a, direction, v->no);
cross_v3_v3v3(dir_b, dir_a, v->no); cross_v3_v3v3(dir_b, dir_a, v->no);
/* The four vectors which will be used for smoothing. /* The four vectors which will be used for smoothing.
* Ocasionally less than 4 verts match the requirements in that case * Occasionally less than 4 verts match the requirements in that case
* use v as fallback. */ * use 'v' as fallback. */
BMVert *pos_a = v; BMVert *pos_a = v;
BMVert *neg_a = v; BMVert *neg_a = v;
BMVert *pos_b = v; BMVert *pos_b = v;

View File

@@ -204,8 +204,8 @@ void outliner_cleanup_tree(SpaceOutliner *soops)
/** /**
* Free \a element and its sub-tree and remove its link in \a parent_subtree. * Free \a element and its sub-tree and remove its link in \a parent_subtree.
* *
* \note Does not remove the TreeStoreElem of \a element! * \note Does not remove the #TreeStoreElem of \a element!
* \param parent_subtree: Subtree of the parent element, so the list containing \a element. * \param parent_subtree: Sub-tree of the parent element, so the list containing \a element.
*/ */
void outliner_free_tree_element(TreeElement *element, ListBase *parent_subtree) void outliner_free_tree_element(TreeElement *element, ListBase *parent_subtree)
{ {
@@ -1619,7 +1619,7 @@ static TreeElement *outliner_find_first_desired_element_at_y_recursive(
* Find the first element that passes a test starting from a reference vertical coordinate * Find the first element that passes a test starting from a reference vertical coordinate
* *
* If the element that is in the position is not what we are looking for, keep looking for its * If the element that is in the position is not what we are looking for, keep looking for its
* children, siblings, and eventually, aunts, cousins, disntant families, ... * children, siblings, and eventually, aunts, cousins, distant families, ... etc.
* *
* Basically we keep going up and down the outliner tree from that point forward, until we find * Basically we keep going up and down the outliner tree from that point forward, until we find
* what we are looking for. If we are past the visible range and we can't find a valid element * what we are looking for. If we are past the visible range and we can't find a valid element

View File

@@ -1171,8 +1171,8 @@ static int object_select_menu_exec(bContext *C, wmOperator *op)
CTX_DATA_BEGIN (C, Base *, base, selectable_bases) CTX_DATA_BEGIN (C, Base *, base, selectable_bases)
{ {
/* this is a bit dodjy, there should only be ONE object with this name, /* This is a bit dodgy, there should only be ONE object with this name,
* but library objects can mess this up */ * but library objects can mess this up. */
if (STREQ(name, base->object->id.name + 2)) { if (STREQ(name, base->object->id.name + 2)) {
ED_object_base_activate(C, base); ED_object_base_activate(C, base);
ED_object_base_select(base, BA_SELECT); ED_object_base_select(base, BA_SELECT);

View File

@@ -2400,10 +2400,10 @@ bool initTransform(bContext *C, TransInfo *t, wmOperator *op, const wmEvent *eve
/* keymap for shortcut header prints */ /* keymap for shortcut header prints */
t->keymap = WM_keymap_active(CTX_wm_manager(C), op->type->modalkeymap); t->keymap = WM_keymap_active(CTX_wm_manager(C), op->type->modalkeymap);
/* Stupid code to have Ctrl-Click on gizmo work ok /* Stupid code to have Ctrl-Click on gizmo work ok.
* *
* do this only for translation/rotation/resize due to only this * Do this only for translation/rotation/resize because only these
* moded are available from gizmo and doing such check could * modes are available from gizmo and doing such check could
* lead to keymap conflicts for other modes (see #31584) * lead to keymap conflicts for other modes (see #31584)
*/ */
if (ELEM(mode, TFM_TRANSLATION, TFM_ROTATION, TFM_RESIZE)) { if (ELEM(mode, TFM_TRANSLATION, TFM_ROTATION, TFM_RESIZE)) {

View File

@@ -707,7 +707,7 @@ enum {
T_POINTS = 1 << 6, T_POINTS = 1 << 6,
/** /**
* Apply matrix #TransDataContainer.matrix, this avoids having to have duplicate check all over * Apply matrix #TransDataContainer.matrix, this avoids having to have duplicate check all over
* that happen to apply to spesiifc modes (edit & pose for eg). */ * that happen to apply to specific modes (edit & pose for eg). */
T_LOCAL_MATRIX = 1 << 7, T_LOCAL_MATRIX = 1 << 7,
/** restrictions flags */ /** restrictions flags */

View File

@@ -751,7 +751,7 @@ typedef enum eNlaStrip_Flag {
// NLASTRIP_FLAG_SELECT_R = (1<<3), // right handle selected // NLASTRIP_FLAG_SELECT_R = (1<<3), // right handle selected
/* NLA strip uses the same action that the action being tweaked uses /* NLA strip uses the same action that the action being tweaked uses
* (not set for the twaking one though) */ * (not set for the tweaking one though). */
NLASTRIP_FLAG_TWEAKUSER = (1<<4), NLASTRIP_FLAG_TWEAKUSER = (1<<4),
/* controls driven by local F-Curves */ /* controls driven by local F-Curves */

View File

@@ -141,7 +141,7 @@ typedef struct Panel {
/** Defined as UI_MAX_NAME_STR. */ /** Defined as UI_MAX_NAME_STR. */
char panelname[64], tabname[64]; char panelname[64], tabname[64];
/** Panelname is identifier for restoring location. */ /** Panel name is identifier for restoring location. */
char drawname[64]; char drawname[64];
/** Offset within the region. */ /** Offset within the region. */
int ofsx, ofsy; int ofsx, ofsy;
@@ -154,7 +154,7 @@ typedef struct Panel {
short flag, runtime_flag; short flag, runtime_flag;
short control; short control;
short snap; short snap;
/** Panels are aligned according to increasing sortorder. */ /** Panels are aligned according to increasing sort-order. */
int sortorder; int sortorder;
/** This panel is tabbed in *paneltab. */ /** This panel is tabbed in *paneltab. */
struct Panel *paneltab; struct Panel *paneltab;
@@ -165,15 +165,16 @@ typedef struct Panel {
} Panel; } Panel;
/* Notes on Panel Catogories: /**
* Notes on Panel Categories:
* *
* ar->panels_category (PanelCategoryDyn) is a runtime only list of categories collected during draw. * - #ARegion.panels_category (#PanelCategoryDyn) is a runtime only list of categories collected during draw.
* *
* ar->panels_category_active (PanelCategoryStack) is basically a list of strings (category id's). * - #ARegion.panels_category_active (#PanelCategoryStack) is basically a list of strings (category id's).
* *
* Clicking on a tab moves it to the front of ar->panels_category_active, * Clicking on a tab moves it to the front of ar->panels_category_active,
* If the context changes so this tab is no longer displayed, * If the context changes so this tab is no longer displayed,
* then the first-most tab in ar->panels_category_active is used. * then the first-most tab in #ARegion.panels_category_active is used.
* *
* This way you can change modes and always have the tab you last clicked on. * This way you can change modes and always have the tab you last clicked on.
*/ */
@@ -634,4 +635,5 @@ enum {
#define RGN_DRAWING 4 #define RGN_DRAWING 4
#define RGN_DRAW_REFRESH_UI 8 /* re-create uiBlock's where possible */ #define RGN_DRAW_REFRESH_UI 8 /* re-create uiBlock's where possible */
#define RGN_DRAW_NO_REBUILD 16 #define RGN_DRAW_NO_REBUILD 16
#endif
#endif /* __DNA_SCREEN_TYPES_H__ */

View File

@@ -142,7 +142,7 @@ typedef struct WorkSpace {
/** /**
* BAD DESIGN WARNING: * BAD DESIGN WARNING:
* This is a workaround for the topbar not knowing which tools spac */ * This is a workaround for the topbar not knowing which tools spec. */
char tools_space_type; char tools_space_type;
/** Type is different for each space-type. */ /** Type is different for each space-type. */
char tools_mode; char tools_mode;