Cleanup: spelling in comments

This commit is contained in:
Campbell Barton 2022-06-27 17:29:57 +10:00
parent e1c0d18598
commit 7b6b740ace
10 changed files with 19 additions and 19 deletions

View File

@ -1137,7 +1137,7 @@ static void cursor_buffer_handle_release(void *data, struct wl_buffer *wl_buffer
wl_buffer_destroy(wl_buffer);
if (wl_buffer == cursor->wl_buffer) {
/* the mapped buffer was from a custom cursor */
/* The mapped buffer was from a custom cursor. */
cursor->wl_buffer = nullptr;
}
}
@ -2724,7 +2724,7 @@ GHOST_IWindow *GHOST_SystemWayland::createWindow(const char *title,
const bool is_dialog,
const GHOST_IWindow *parentWindow)
{
/* globally store pointer to window manager */
/* Globally store pointer to window manager. */
if (!window_manager) {
window_manager = getWindowManager();
}
@ -3219,7 +3219,7 @@ GHOST_TSuccess GHOST_SystemWayland::setCursorGrab(const GHOST_TGrabCursorMode mo
const GHOST_TGrabCursorMode mode_current,
wl_surface *surface)
{
/* ignore, if the required protocols are not supported */
/* Ignore, if the required protocols are not supported. */
if (!d->relative_pointer_manager || !d->pointer_constraints) {
return GHOST_kFailure;
}

View File

@ -232,7 +232,7 @@ static void frame_handle_close(struct libdecor_frame * /*frame*/, void *data)
static void frame_handle_commit(struct libdecor_frame * /*frame*/, void *data)
{
/* we have to swap twice to keep any pop-up menues alive */
/* We have to swap twice to keep any pop-up menus alive. */
static_cast<window_t *>(data)->w->swapBuffers();
static_cast<window_t *>(data)->w->swapBuffers();
}
@ -469,7 +469,7 @@ GHOST_WindowWayland::GHOST_WindowWayland(GHOST_SystemWayland *system,
setOpaque();
#endif
#ifndef WITH_GHOST_WAYLAND_LIBDECOR /* Causes a glicth with libdecor for some reason. */
#ifndef WITH_GHOST_WAYLAND_LIBDECOR /* Causes a glitch with `libdecor` for some reason. */
setState(state);
#endif
@ -480,7 +480,7 @@ GHOST_WindowWayland::GHOST_WindowWayland(GHOST_SystemWayland *system,
GHOST_PRINT("Failed to create EGL context" << std::endl);
}
/* set swap interval to 0 to prevent blocking */
/* Set swap interval to 0 to prevent blocking. */
setSwapInterval(0);
}

View File

@ -132,7 +132,7 @@ Curves *curve_legacy_to_curves(const Curve &curve_legacy, const ListBase &nurbs_
});
};
/* Note: For curve handles, legacy curves can end up in invalid situations where the handle
/* NOTE: For curve handles, legacy curves can end up in invalid situations where the handle
* positions don't agree with the types because of evaluation, or because one-sided aligned
* handles weren't considered. While recalculating automatic handles to fix those situations
* is an option, currently this opts not to for the sake of flexibility. */

View File

@ -2273,7 +2273,7 @@ Object *BKE_object_add(Main *bmain, ViewLayer *view_layer, int type, const char
LayerCollection *layer_collection = BKE_layer_collection_get_active(view_layer);
BKE_collection_viewlayer_object_add(bmain, view_layer, layer_collection->collection, ob);
/* Note: There is no way to be sure that #BKE_collection_viewlayer_object_add will actually
/* NOTE: There is no way to be sure that #BKE_collection_viewlayer_object_add will actually
* manage to find a valid collection in given `view_layer` to add the new object to. */
Base *base = BKE_view_layer_base_find(view_layer, ob);
if (base != nullptr) {

View File

@ -60,7 +60,7 @@ inline IndexMask find_indices_based_on_predicate(const IndexMask indices_to_chec
/**
* Find the true indices in a virtual array. This is a version of
* #find_indices_based_on_predicate optimised for a virtual array input.
* #find_indices_based_on_predicate optimized for a virtual array input.
*
* \param parallel_grain_size: The grain size for when the virtual array isn't a span or a single
* value internally. This should be adjusted based on the expected cost of evaluating the virtual

View File

@ -1244,7 +1244,7 @@ static int object_calculate_paths_exec(bContext *C, wmOperator *op)
/* notifiers for updates */
WM_event_add_notifier(C, NC_OBJECT | ND_DRAW_ANIMVIZ, NULL);
/* Note: the notifier below isn't actually correct, but kept around just to be on the safe side.
/* NOTE: the notifier below isn't actually correct, but kept around just to be on the safe side.
* If further testing shows it's not necessary (for both bones and objects) removal is fine. */
WM_event_add_notifier(C, NC_OBJECT | ND_TRANSFORM | ND_POSE, NULL);
@ -1316,7 +1316,7 @@ static int object_update_paths_exec(bContext *C, wmOperator *op)
/* notifiers for updates */
WM_event_add_notifier(C, NC_OBJECT | ND_DRAW_ANIMVIZ, NULL);
/* Note: the notifier below isn't actually correct, but kept around just to be on the safe side.
/* NOTE: the notifier below isn't actually correct, but kept around just to be on the safe side.
* If further testing shows it's not necessary (for both bones and objects) removal is fine. */
WM_event_add_notifier(C, NC_OBJECT | ND_TRANSFORM | ND_POSE, NULL);

View File

@ -309,7 +309,7 @@ typedef struct LineartData {
LineartElementLinkNode *isect_scheduled_up_to;
int isect_scheduled_up_to_index;
/* Note: Data inside #pending_edges are allocated with MEM_xxx call instead of in pool. */
/* NOTE: Data inside #pending_edges are allocated with MEM_xxx call instead of in pool. */
struct LineartPendingEdges pending_edges;
int scheduled_count;
@ -382,7 +382,7 @@ typedef struct LineartObjectInfo {
bool free_use_mesh;
/* Note: Data inside #pending_edges are allocated with MEM_xxx call instead of in pool. */
/** NOTE: Data inside #pending_edges are allocated with MEM_xxx call instead of in pool. */
struct LineartPendingEdges pending_edges;
} LineartObjectInfo;

View File

@ -1772,7 +1772,7 @@ static void lineart_add_edge_to_array_thread(LineartObjectInfo *obi, LineartEdge
lineart_add_edge_to_array(&obi->pending_edges, e);
}
/* Note: For simplicity, this function doesn't actually do anything if you already have data in
/* NOTE: For simplicity, this function doesn't actually do anything if you already have data in
* #pe. */
static void lineart_finalize_object_edge_array_reserve(LineartPendingEdges *pe, int count)
{

View File

@ -70,7 +70,7 @@ Object *MeshFromGeometry::create_mesh(Main *bmain,
BKE_mesh_nomain_to_mesh(mesh, dst, obj, &CD_MASK_EVERYTHING, true);
dst->flag |= autosmooth;
/* Note: vertex groups have to be created after final mesh is assigned to the object. */
/* NOTE: vertex groups have to be created after final mesh is assigned to the object. */
create_vertex_groups(obj);
return obj;

View File

@ -4424,7 +4424,7 @@ int rna_parameter_size(PropertyRNA *parm)
int rna_parameter_size_pad(const int size)
{
/* Pad parameters in memory so the next parameter is properly aligned.
* This silences warnings in ubsan. More complicated logic to pack parameters
* This silences warnings in UBSAN. More complicated logic to pack parameters
* more tightly in memory is unlikely to improve performance, and aligning
* to the requirements for pointers is enough for all data types we use. */
const int alignment = sizeof(void *);
@ -4445,7 +4445,7 @@ void RNA_enum_item_add(EnumPropertyItem **items, int *totitem, const EnumPropert
#endif
}
else if (tot >= 8 && (tot & (tot - 1)) == 0) {
/* power of two > 8 */
/* Power of two > 8. */
*items = MEM_recallocN_id(*items, sizeof(EnumPropertyItem) * tot * 2, __func__);
#ifdef DEBUG
memset((*items) + tot, 0xff, sizeof(EnumPropertyItem) * tot);
@ -4477,8 +4477,8 @@ void RNA_enum_items_add_value(EnumPropertyItem **items,
for (; item->identifier; item++) {
if (item->value == value) {
RNA_enum_item_add(items, totitem, item);
/* break on first match - does this break anything?
* (is quick hack to get object->parent_type working ok for armature/lattice) */
/* Break on first match - does this break anything?
* (is quick hack to get `object->parent_type` working ok for armature/lattice). */
break;
}
}