Cleanup: spelling in comments

This commit is contained in:
Campbell Barton 2022-01-26 16:06:22 +11:00
parent 94d2a611ec
commit b06fff4737
9 changed files with 17 additions and 13 deletions

View File

@ -401,7 +401,7 @@ ccl_device_inline float fractf(float x)
return x - floorf(x);
}
/* Adapted from godot-engine math_funcs.h. */
/* Adapted from `godot-engine` math_funcs.h. */
ccl_device_inline float wrapf(float value, float max, float min)
{
float range = max - min;

View File

@ -72,7 +72,7 @@ void BKE_crazyspace_build_sculpt(struct Depsgraph *depsgraph,
float (**deformcos)[3]);
/* -------------------------------------------------------------------- */
/** \name Crazyspace API
/** \name Crazy-Space API
* \{ */
void BKE_crazyspace_api_eval(struct Depsgraph *depsgraph,

View File

@ -157,7 +157,8 @@ int BKE_layer_collection_findindex(struct ViewLayer *view_layer, const struct La
void BKE_layer_collection_resync_forbid(void);
void BKE_layer_collection_resync_allow(void);
/** Helper to fix older pre-2.80 blendfiles.
/**
* Helper to fix older pre-2.80 blend-files.
*
* Ensures the given `view_layer` as a valid first-level layer collection, i.e. a single one
* matching the scene's master collection. This is a requirement for `BKE_layer_collection_sync`.

View File

@ -462,7 +462,7 @@ void BKE_lib_id_make_local_generic_action_define(
BLI_assert(force_copy == false || force_copy != force_local);
if (force_local || force_copy) {
/* Already set by caller code, nothig to do here. */
/* Already set by caller code, nothing to do here. */
*r_force_local = force_local;
*r_force_copy = force_copy;
return;

View File

@ -4572,7 +4572,7 @@ Mesh *BKE_object_get_editmesh_eval_final(const Object *object)
const Mesh *mesh = static_cast<const Mesh *>(object->data);
if (mesh->edit_mesh == nullptr) {
/* Heppens when requesting material of evaluated 3d font obejct: the evaluated object get
/* Happens when requesting material of evaluated 3d font object: the evaluated object get
* converted to mesh, and it does not have edit mesh. */
return nullptr;
}

View File

@ -33,8 +33,8 @@ namespace blender::geometry {
* Merge selected vertices into other selected vertices within the \a merge_distance. The merged
* indices favor speed over accuracy, since the results will depend on the order of the vertices.
*
* \returns std::nullopt if the mesh should not be changed (no vertices are merged), in order to
* avoid copying the input. Otherwise returns the new mesh with merged geoemetry.
* \returns #std::nullopt if the mesh should not be changed (no vertices are merged), in order to
* avoid copying the input. Otherwise returns the new mesh with merged geometry.
*/
std::optional<Mesh *> mesh_merge_by_distance_all(const Mesh &mesh,
IndexMask selection,
@ -44,8 +44,8 @@ std::optional<Mesh *> mesh_merge_by_distance_all(const Mesh &mesh,
* Merge selected vertices along edges to other selected vertices. Only vertices connected by edges
* are considered for merging.
*
* \returns std::nullopt if the mesh should not be changed (no vertices are merged), in order to
* avoid copying the input. Otherwise returns the new mesh with merged geoemetry.
* \returns #std::nullopt if the mesh should not be changed (no vertices are merged), in order to
* avoid copying the input. Otherwise returns the new mesh with merged geometry.
*/
std::optional<Mesh *> mesh_merge_by_distance_connected(const Mesh &mesh,
Span<bool> selection,

View File

@ -105,7 +105,7 @@ void ShaderCreateInfo::finalize()
void ShaderCreateInfo::validate(const ShaderCreateInfo &other_info)
{
{
/* Check same bindpoints usage in OGL. */
/* Check same bind-points usage in OGL. */
Set<int> images, samplers, ubos, ssbos;
auto register_resource = [&](const Resource &res) -> bool {

View File

@ -63,7 +63,10 @@ enum class Type {
};
enum class BuiltinBits {
/** Allow getting barycentic coordinates inside the fragment shader. NOTE: emulated on OpenGL. */
/**
* Allow getting barycentric coordinates inside the fragment shader.
* \note Emulated on OpenGL.
*/
BARYCENTRIC_COORD = (1 << 0),
FRAG_COORD = (1 << 2),
FRONT_FACING = (1 << 4),

View File

@ -522,7 +522,7 @@ typedef enum eBrushUVSculptTool {
SCULPT_TOOL_SLIDE_RELAX, \
SCULPT_TOOL_MASK) == 0)
/* ImagePaintSettings.tool */
/** #ImagePaintSettings.tool */
typedef enum eBrushImagePaintTool {
PAINT_TOOL_DRAW = 0,
PAINT_TOOL_SOFTEN = 1,
@ -534,7 +534,7 @@ typedef enum eBrushImagePaintTool {
/* The enums here should be kept in sync with the weight paint tool.
* This is because #smooth_brush_toggle_on and #smooth_brush_toggle_off
* assumes that the Blur blursh has the same enum value. */
* assumes that the blur brush has the same enum value. */
typedef enum eBrushVertexPaintTool {
VPAINT_TOOL_DRAW = 0,
VPAINT_TOOL_BLUR = 1,