Cleanup: spelling in comments

This commit is contained in:
Campbell Barton
2022-01-20 11:55:33 +11:00
parent 1d536c21dd
commit eb3ff1d6f9
11 changed files with 20 additions and 20 deletions

View File

@@ -544,7 +544,7 @@ void GHOST_WindowX11::refreshXInputDevices()
std::vector<XEventClass> xevents;
for (GHOST_SystemX11::GHOST_TabletX11 &xtablet : m_system->GetXTablets()) {
/* With modern XInput (xlib 1.6.2 at least and/or evdev 2.9.0) and some 'no-name' tablets
/* With modern XInput (XLIB 1.6.2 at least and/or EVDEV 2.9.0) and some 'no-name' tablets
* like 'UC-LOGIC Tablet WP5540U', we also need to 'select' ButtonPress for motion event,
* otherwise we do not get any tablet motion event once pen is pressed... See T43367.
*/

View File

@@ -398,7 +398,7 @@ MINLINE float fractf(float a)
return a - floorf(a);
}
/* Adapted from godot-engine math_funcs.h. */
/* Adapted from `godot-engine` math_funcs.h. */
MINLINE float wrapf(float value, float max, float min)
{
float range = max - min;
@@ -722,15 +722,15 @@ MINLINE int integer_digits_i(const int i)
#ifdef BLI_HAVE_SSE2
/* Calculate initial guess for arg^exp based on float representation
/**
* Calculate initial guess for `arg^exp` based on float representation
* This method gives a constant bias, which can be easily compensated by
* multiplying with bias_coeff.
* Gives better results for exponents near 1 (e. g. 4/5).
* Gives better results for exponents near 1 (e.g. `4/5`).
* exp = exponent, encoded as uint32_t
* e2coeff = 2^(127/exponent - 127) * bias_coeff^(1/exponent), encoded as
* uint32_t
* `e2coeff = 2^(127/exponent - 127) * bias_coeff^(1/exponent)`, encoded as `uint32_t`.
*
* We hope that exp and e2coeff gets properly inlined
* We hope that exp and e2coeff gets properly inlined.
*/
MALWAYS_INLINE __m128 _bli_math_fastpow(const int exp, const int e2coeff, const __m128 arg)
{
@@ -742,7 +742,7 @@ MALWAYS_INLINE __m128 _bli_math_fastpow(const int exp, const int e2coeff, const
return ret;
}
/* Improve x ^ 1.0f/5.0f solution with Newton-Raphson method */
/** Improve `x ^ 1.0f/5.0f` solution with Newton-Raphson method */
MALWAYS_INLINE __m128 _bli_math_improve_5throot_solution(const __m128 old_result, const __m128 x)
{
__m128 approx2 = _mm_mul_ps(old_result, old_result);
@@ -752,7 +752,7 @@ MALWAYS_INLINE __m128 _bli_math_improve_5throot_solution(const __m128 old_result
return _mm_mul_ps(summ, _mm_set1_ps(1.0f / 5.0f));
}
/* Calculate powf(x, 2.4). Working domain: 1e-10 < x < 1e+10 */
/** Calculate `powf(x, 2.4)`. Working domain: `1e-10 < x < 1e+10`. */
MALWAYS_INLINE __m128 _bli_math_fastpow24(const __m128 arg)
{
/* max, avg and |avg| errors were calculated in gcc without FMA instructions

View File

@@ -3720,7 +3720,7 @@ void barycentric_weights_v2_quad(const float v1[2],
/* NOTE(campbell): fabsf() here is not needed for convex quads
* (and not used in #interp_weights_poly_v2).
* But in the case of concave/bow-tie quads for the mask rasterizer it
* gives unreliable results without adding absf(). If this becomes an issue for more general
* gives unreliable results without adding `absf()`. If this becomes an issue for more general
* usage we could have this optional or use a different function. */
#define MEAN_VALUE_HALF_TAN_V2(_area, i1, i2) \
((_area = cross_v2v2(dirs[i1], dirs[i2])) != 0.0f ? \

View File

@@ -49,7 +49,7 @@ size_t BLI_timecode_string_from_time(char *str,
/* get cframes */
if (time < 0) {
/* correction for negative cfraues */
/* Correction for negative cframes. */
neg[0] = '-';
time = -time;
}

View File

@@ -928,7 +928,7 @@ void BM_mesh_remap(BMesh *bm, const uint *vert_idx, const uint *edge_idx, const
/* Edges' pointers, only vert pointers (as we don't mess with loops!),
* and - ack! - edge pointers,
* as we have to handle disklinks... */
* as we have to handle disk-links. */
if (vptr_map || eptr_map) {
BM_ITER_MESH (ed, &iter, bm, BM_EDGES_OF_MESH) {
if (vptr_map) {

View File

@@ -17,7 +17,7 @@
/** \file
* \ingroup bmesh
*
* Create faces or edges (Fkey by default).
* Create faces or edges (F-key by default).
*/
#include "MEM_guardedalloc.h"

View File

@@ -30,7 +30,7 @@
# include "RBI_hull_api.h"
/* XXX: using 128 for totelem and pchunk of mempool, no idea what good
/* XXX: using 128 for totelem and `pchunk` of `mempool`, no idea what good
* values would be though */
# include "bmesh.h"

View File

@@ -1544,7 +1544,7 @@ void SCULPT_OT_mask_init(struct wmOperatorType *ot);
/* Detail size. */
/* -------------------------------------------------------------------- */
/** \name Dyntopo/Retopo Operators
/** \name Dyntopo/Retopology Operators
* \{ */
void SCULPT_OT_detail_flood_fill(struct wmOperatorType *ot);

View File

@@ -29,10 +29,10 @@ namespace blender::gpu {
/**
* This includes both hardware capabilities & workarounds.
* Try to limit these to the implementation codebase (i.e.: gpu/opengl/).
* Try to limit these to the implementation code-base (i.e.: `gpu/opengl/`).
* Only add workarounds here if they are common to all implementation or
* if you need access to it outside of the GPU module.
* Same goes for capabilities (i.e.: texture size)
* Same goes for capabilities (i.e.: texture size).
*/
struct GPUCapabilities {
int max_texture_size = 0;

View File

@@ -172,8 +172,8 @@ class OBJMesh : NonCopyable {
*/
float3 calc_poly_normal(int poly_index) const;
/**
* Find the unqique normals of the mesh and return them in \a r_normal_coords.
* Store the indices into that vector with for each loop in this OBJMesh.
* Find the unique normals of the mesh and return them in \a r_normal_coords.
* Store the indices into that vector with for each loop in this #OBJMesh.
*/
void store_normal_coords_and_indices(Vector<float3> &r_normal_coords);
/**

View File

@@ -29,7 +29,7 @@
#include "obj_exporter_tests.hh"
namespace blender::io::obj {
/* Set this true to keep comparison-failing test ouput in temp file directory. */
/* Set this true to keep comparison-failing test output in temp file directory. */
constexpr bool save_failing_test_output = false;
/* This is also the test name. */