Cleanup: Grammar in comments

This commit is contained in:
Hans Goudey 2024-01-11 11:01:44 -05:00
parent 2bbf65f6e5
commit 6438d0ad1f
14 changed files with 25 additions and 25 deletions

View File

@ -1327,7 +1327,7 @@ struct GWL_Display {
}; };
/** /**
* Free the #GWL_Display and it's related members. * Free the #GWL_Display and its related members.
* *
* \note This may run on a partially initialized struct, * \note This may run on a partially initialized struct,
* so it can't be assumed all members are set. * so it can't be assumed all members are set.

View File

@ -1,8 +1,8 @@
# Example of a group that edits a single property # Example of a group that edits a single property
# using the predefined gizmo arrow. # using the predefined gizmo arrow.
# #
# Usage: Select a light in the 3D view and drag the arrow at it's rear # Usage: Select a light in the 3D view and drag the arrow at its rear
# to change it's energy value. # to change its energy value.
# #
import bpy import bpy
from bpy.types import ( from bpy.types import (

View File

@ -90,10 +90,10 @@ struct ObjectRuntime {
/** /**
* Evaluated mesh cage in edit mode. * Evaluated mesh cage in edit mode.
* *
* \note When it's `runtime->deformed_only` is true, the meshes vertex positions * \note When the mesh's `runtime->deformed_only` is true, the meshes vertex positions
* and other geometry arrays will be aligned the edit-mesh. * and other geometry arrays will be aligned the edit-mesh. Otherwise the #CD_ORIGINDEX
* Otherwise the #CD_ORIGINDEX custom-data should be used to map the cage geometry * custom-data should be used to map the cage geometry back to the original indices, see
* back to the original indices, see #eModifierTypeFlag_SupportsMapping. * #eModifierTypeFlag_SupportsMapping.
*/ */
Mesh *editmesh_eval_cage = nullptr; Mesh *editmesh_eval_cage = nullptr;

View File

@ -37,7 +37,7 @@ enum eSubdivFVarLinearInterpolation {
}; };
struct SubdivSettings { struct SubdivSettings {
/* Simple subdivision corresponds to "Simple" option in the interface. When it's enabled the /* Simple subdivision corresponds to "Simple" option in the interface. When it's enabled, the
* subdivided mesh is not "smoothed": new vertices are added uniformly on the existing surface. * subdivided mesh is not "smoothed": new vertices are added uniformly on the existing surface.
* *
* On an OpenSubdiv implementation level this translates to a subdivision scheme: * On an OpenSubdiv implementation level this translates to a subdivision scheme:

View File

@ -1108,7 +1108,7 @@ static bool skip_fcurve_selected_data(bDopeSheet *ads, FCurve *fcu, ID *owner_id
* since data-paths that point to missing strips are not shown. * since data-paths that point to missing strips are not shown.
* If this is an important difference, the nullptr case could perform a global lookup, * If this is an important difference, the nullptr case could perform a global lookup,
* only returning `true` if the sequence strip exists elsewhere * only returning `true` if the sequence strip exists elsewhere
* (ignoring it's selection state). */ * (ignoring its selection state). */
if (seq == nullptr) { if (seq == nullptr) {
return true; return true;
} }

View File

@ -75,7 +75,7 @@ static bool handle_range(const int curve_index,
} }
/** /**
* Calculates number of points in resulting curve denoted by #curve_index and sets it's * Calculates number of points in resulting curve denoted by #curve_index and sets its
* #curve_offsets value. * #curve_offsets value.
*/ */
static void calc_curve_offset(const int curve_index, static void calc_curve_offset(const int curve_index,

View File

@ -453,7 +453,7 @@ void ED_object_posemode_set_for_weight_paint(bContext *C,
* Return the index of an object in a mode (typically edit/pose mode). * Return the index of an object in a mode (typically edit/pose mode).
* *
* Useful for operators with multi-mode editing to be able to redo an action on an object * Useful for operators with multi-mode editing to be able to redo an action on an object
* by it's index which (unlike pointers) the operator can store for redo. * by its index which (unlike pointers) the operator can store for redo.
* *
* The indices aren't intended to be useful from Python scripts, * The indices aren't intended to be useful from Python scripts,
* although they are not prevented from passing them in, this is mainly to enable redo. * although they are not prevented from passing them in, this is mainly to enable redo.

View File

@ -652,7 +652,7 @@ bool ED_view3d_win_to_3d_on_plane_int(
* \param region: The region (used for the window width and height). * \param region: The region (used for the window width and height).
* \param xy_delta: 2D difference (in pixels) such as `event->mval[0] - other_x`. * \param xy_delta: 2D difference (in pixels) such as `event->mval[0] - other_x`.
* \param zfac: The depth result typically calculated by #ED_view3d_calc_zfac * \param zfac: The depth result typically calculated by #ED_view3d_calc_zfac
* (see it's doc-string for details). * (see its doc-string for details).
* \param r_out: The resulting world-space delta. * \param r_out: The resulting world-space delta.
*/ */
void ED_view3d_win_to_delta(const ARegion *region, void ED_view3d_win_to_delta(const ARegion *region,
@ -936,7 +936,7 @@ ViewContext ED_view3d_viewcontext_init(bContext *C, Depsgraph *depsgraph);
* Re-initialize `vc` with `obact` as if it's active object (with some differences). * Re-initialize `vc` with `obact` as if it's active object (with some differences).
* *
* This is often used when operating on multiple objects in modes (edit, pose mode etc) * This is often used when operating on multiple objects in modes (edit, pose mode etc)
* where the `vc` is passed in as an argument which then references it's object data. * where the `vc` is passed in as an argument which then references its object data.
* *
* \note members #ViewContext.obedit & #ViewContext.em are only initialized if they're already set, * \note members #ViewContext.obedit & #ViewContext.em are only initialized if they're already set,
* by #ED_view3d_viewcontext_init in most cases. * by #ED_view3d_viewcontext_init in most cases.

View File

@ -156,7 +156,7 @@ void GPU_line_smooth(bool enable);
/** /**
* \note By convention, this is set as needed and not reset back to 1.0. * \note By convention, this is set as needed and not reset back to 1.0.
* This means code that draws lines must always set the line width beforehand, * This means code that draws lines must always set the line width beforehand,
* but is not expected to restore it's previous value. * but is not expected to restore its previous value.
*/ */
void GPU_line_width(float width); void GPU_line_width(float width);
void GPU_logic_op_xor_set(bool enable); void GPU_logic_op_xor_set(bool enable);

View File

@ -469,7 +469,7 @@ vec2 normalize_and_get_length(vec2 vector, out float out_length)
out_length = sqrt(out_length); out_length = sqrt(out_length);
return vector / out_length; return vector / out_length;
} }
/* Either the vector is small or one of it's values contained `nan`. */ /* Either the vector is small or one of its values contained `nan`. */
out_length = 0.0; out_length = 0.0;
return vec2(0.0); return vec2(0.0);
} }
@ -481,7 +481,7 @@ vec3 normalize_and_get_length(vec3 vector, out float out_length)
out_length = sqrt(out_length); out_length = sqrt(out_length);
return vector / out_length; return vector / out_length;
} }
/* Either the vector is small or one of it's values contained `nan`. */ /* Either the vector is small or one of its values contained `nan`. */
out_length = 0.0; out_length = 0.0;
return vec3(0.0); return vec3(0.0);
} }
@ -493,7 +493,7 @@ vec4 normalize_and_get_length(vec4 vector, out float out_length)
out_length = sqrt(out_length); out_length = sqrt(out_length);
return vector / out_length; return vector / out_length;
} }
/* Either the vector is small or one of it's values contained `nan`. */ /* Either the vector is small or one of its values contained `nan`. */
out_length = 0.0; out_length = 0.0;
return vec4(0.0); return vec4(0.0);
} }
@ -506,7 +506,7 @@ vec2 safe_normalize_and_get_length(vec2 vector, out float out_length)
out_length = sqrt(out_length); out_length = sqrt(out_length);
return vector / out_length; return vector / out_length;
} }
/* Either the vector is small or one of it's values contained `nan`. */ /* Either the vector is small or one of its values contained `nan`. */
out_length = 0.0; out_length = 0.0;
return vec2(1.0, 0.0); return vec2(1.0, 0.0);
} }
@ -518,7 +518,7 @@ vec3 safe_normalize_and_get_length(vec3 vector, out float out_length)
out_length = sqrt(out_length); out_length = sqrt(out_length);
return vector / out_length; return vector / out_length;
} }
/* Either the vector is small or one of it's values contained `nan`. */ /* Either the vector is small or one of its values contained `nan`. */
out_length = 0.0; out_length = 0.0;
return vec3(1.0, 0.0, 0.0); return vec3(1.0, 0.0, 0.0);
} }
@ -530,7 +530,7 @@ vec4 safe_normalize_and_get_length(vec4 vector, out float out_length)
out_length = sqrt(out_length); out_length = sqrt(out_length);
return vector / out_length; return vector / out_length;
} }
/* Either the vector is small or one of it's values contained `nan`. */ /* Either the vector is small or one of its values contained `nan`. */
out_length = 0.0; out_length = 0.0;
return vec4(1.0, 0.0, 0.0, 0.0); return vec4(1.0, 0.0, 0.0, 0.0);
} }

View File

@ -1206,7 +1206,7 @@ typedef struct IdAdtTemplate {
AnimData *adt; AnimData *adt;
} IdAdtTemplate; } IdAdtTemplate;
/* From: `DNA_object_types.h`, see it's doc-string there. */ /* From: `DNA_object_types.h`, see its doc-string there. */
#define SELECT 1 #define SELECT 1
/* ************************************************ */ /* ************************************************ */

View File

@ -731,7 +731,7 @@ typedef struct bNodeTree {
const bNode *find_nested_node(int32_t nested_node_id) const; const bNode *find_nested_node(int32_t nested_node_id) const;
/** /**
* Update a run-time cache for the node tree based on it's current state. This makes many methods * Update a run-time cache for the node tree based on its current state. This makes many methods
* available which allow efficient lookup for topology information (like neighboring sockets). * available which allow efficient lookup for topology information (like neighboring sockets).
*/ */
void ensure_topology_cache() const; void ensure_topology_cache() const;
@ -786,7 +786,7 @@ typedef struct bNodeTree {
const blender::bke::bNodeTreeZones *zones() const; const blender::bke::bNodeTreeZones *zones() const;
/** /**
* Update a run-time cache for the node tree interface based on it's current state. * Update a run-time cache for the node tree interface based on its current state.
* This should be done before accessing interface item spans below. * This should be done before accessing interface item spans below.
*/ */
void ensure_interface_cache() const; void ensure_interface_cache() const;

View File

@ -560,7 +560,7 @@ typedef void (*StringPropertySearchVisitFunc)(void *visit_user_data,
/** /**
* \param C: context, may be NULL (in this case all available items should be shown). * \param C: context, may be NULL (in this case all available items should be shown).
* \param ptr: RNA pointer. * \param ptr: RNA pointer.
* \param prop: RNA property. This must have it's #StringPropertyRNA.search callback set, * \param prop: RNA property. This must have its #StringPropertyRNA.search callback set,
* to check this use `RNA_property_string_search_flag(prop) & PROP_STRING_SEARCH_SUPPORTED`. * to check this use `RNA_property_string_search_flag(prop) & PROP_STRING_SEARCH_SUPPORTED`.
* \param edit_text: Optionally use the string being edited by the user as a basis * \param edit_text: Optionally use the string being edited by the user as a basis
* for the search results (auto-complete Python attributes for e.g.). * for the search results (auto-complete Python attributes for e.g.).

View File

@ -351,7 +351,7 @@ struct PlayAnimPict {
/** /**
* Various globals relating to playback. * Various globals relating to playback.
* \note Avoid adding members here where possible, * \note Avoid adding members here where possible,
* prefer #PlayState or one of it's members where possible. * prefer #PlayState or one of its members where possible.
*/ */
static struct { static struct {
bool from_disk; bool from_disk;