Cleanup: spelling in comments

This commit is contained in:
Campbell Barton 2021-08-26 12:27:14 +10:00
parent ff85ac3009
commit afcd06e1e1
11 changed files with 17 additions and 18 deletions

@ -1050,7 +1050,7 @@ ccl_device int bsdf_microfacet_beckmann_sample(KernelGlobals *kg,
float D, G1i; float D, G1i;
if (alpha_x == alpha_y) { if (alpha_x == alpha_y) {
/* istropic distribution */ /* Isotropic distribution. */
float cosThetaM2 = cosThetaM * cosThetaM; float cosThetaM2 = cosThetaM * cosThetaM;
float cosThetaM4 = cosThetaM2 * cosThetaM2; float cosThetaM4 = cosThetaM2 * cosThetaM2;
float tanThetaM2 = 1 / (cosThetaM2)-1; float tanThetaM2 = 1 / (cosThetaM2)-1;

@ -424,7 +424,7 @@ extern "C" int GHOST_HACK_getFirstFile(char buf[FIRSTFILEBUFLG])
{ {
/* TODO: implement graceful termination through Cocoa mechanism /* TODO: implement graceful termination through Cocoa mechanism
* to avoid session log off to be canceled. */ * to avoid session log off to be canceled. */
/* Note that Cmd+Q is already handled by keyhandler. */ /* Note that Cmd+Q is already handled by key-handler. */
systemCocoa->handleQuitRequest(); systemCocoa->handleQuitRequest();
return NSTerminateCancel; return NSTerminateCancel;
} }

@ -1922,7 +1922,7 @@ static GHOST_TKey ghost_key_from_keycode(const XkbDescPtr xkb_descr, const KeyCo
#undef MAKE_ID #undef MAKE_ID
/* from xclip.c xcout() v0.11 */ /* From `xclip.c` #xcout() v0.11. */
#define XCLIB_XCOUT_NONE 0 /* no context */ #define XCLIB_XCOUT_NONE 0 /* no context */
#define XCLIB_XCOUT_SENTCONVSEL 1 /* sent a request */ #define XCLIB_XCOUT_SENTCONVSEL 1 /* sent a request */

@ -172,12 +172,12 @@ char *blf_dir_metrics_search(const char *filename)
s[1] = 'f'; s[1] = 'f';
s[2] = 'm'; s[2] = 'm';
/* first check .afm */ /* First check `.afm`. */
if (BLI_exists(mfile)) { if (BLI_exists(mfile)) {
return mfile; return mfile;
} }
/* and now check .pfm */ /* And now check `.pfm`. */
s[0] = 'p'; s[0] = 'p';
if (BLI_exists(mfile)) { if (BLI_exists(mfile)) {

@ -120,7 +120,7 @@ static void space_image_gpu_texture_get(Image *image,
} }
if (ibuf->rect == NULL && ibuf->rect_float == NULL) { if (ibuf->rect == NULL && ibuf->rect_float == NULL) {
/* This codepath is only supposed to happen when drawing a lazily-allocatable render result. /* This code-path is only supposed to happen when drawing a lazily-allocatable render result.
* In all the other cases the `ED_space_image_acquire_buffer()` is expected to return NULL as * In all the other cases the `ED_space_image_acquire_buffer()` is expected to return NULL as
* an image buffer when it has no pixels. */ * an image buffer when it has no pixels. */

@ -697,7 +697,7 @@ static void gather_frames_to_render(bContext *C, OGLRender *oglrender)
AnimData *adt = BKE_animdata_from_id(id); AnimData *adt = BKE_animdata_from_id(id);
gather_frames_to_render_for_adt(oglrender, adt); gather_frames_to_render_for_adt(oglrender, adt);
/* Gather the frames from linked datablocks (materials, shapkeys, etc.). */ /* Gather the frames from linked data-blocks (materials, shape-keys, etc.). */
BKE_library_foreach_ID_link( BKE_library_foreach_ID_link(
NULL, id, gather_frames_to_render_for_id, oglrender, IDWALK_RECURSE); NULL, id, gather_frames_to_render_for_id, oglrender, IDWALK_RECURSE);
} }

@ -1400,7 +1400,7 @@ static void drawTransformPixel(const struct bContext *C, ARegion *region, void *
/* draw auto-key-framing hint in the corner /* draw auto-key-framing hint in the corner
* - only draw if enabled (advanced users may be distracted/annoyed), * - only draw if enabled (advanced users may be distracted/annoyed),
* for objects that will be autokeyframed (no point otherwise), * for objects that will be auto-keyframed (no point otherwise),
* AND only for the active region (as showing all is too overwhelming) * AND only for the active region (as showing all is too overwhelming)
*/ */
if ((U.autokey_flag & AUTOKEY_FLAG_NOWARNING) == 0) { if ((U.autokey_flag & AUTOKEY_FLAG_NOWARNING) == 0) {

@ -22,7 +22,7 @@
* *
* GPU Capabilities & workarounds * GPU Capabilities & workarounds
* This module expose the reported implementation limits & enabled * This module expose the reported implementation limits & enabled
* workaround for drivers that needs specific codepaths. * workaround for drivers that needs specific code-paths.
*/ */
#pragma once #pragma once

@ -277,8 +277,8 @@ static void blendRead(BlendDataReader *UNUSED(reader), ModifierData *md)
{ {
CollisionModifierData *collmd = (CollisionModifierData *)md; CollisionModifierData *collmd = (CollisionModifierData *)md;
#if 0 #if 0
// TODO: CollisionModifier should use pointcache /* TODO: #CollisionModifier should use point-cache
// + have proper reset events before enabling this * + have proper reset events before enabling this. */
collmd->x = newdataadr(fd, collmd->x); collmd->x = newdataadr(fd, collmd->x);
collmd->xnew = newdataadr(fd, collmd->xnew); collmd->xnew = newdataadr(fd, collmd->xnew);
collmd->mfaces = newdataadr(fd, collmd->mfaces); collmd->mfaces = newdataadr(fd, collmd->mfaces);

@ -107,14 +107,13 @@ static bool seq_for_each_recursive(ListBase *seqbase, SeqForEachFunc callback, v
} }
/** /**
* Utility function to recursivily iterate through all sequence strips in a seqbase list. * Utility function to recursively iterate through all sequence strips in a `seqbase` list.
* Uses callback to do operations on each sequence element. * Uses callback to do operations on each sequence element.
* The callback can stop the iteration if needed. * The callback can stop the iteration if needed.
* *
* \param seqbase: ListBase of sequences to be iterated over * \param seqbase: #ListBase of sequences to be iterated over.
* \param callback: query function callback, returns false if iteration should stop * \param callback: query function callback, returns false if iteration should stop.
* \param user_data: pointer to user data that can be used in the callback function * \param user_data: pointer to user data that can be used in the callback function.
*
*/ */
void SEQ_for_each_callback(ListBase *seqbase, SeqForEachFunc callback, void *user_data) void SEQ_for_each_callback(ListBase *seqbase, SeqForEachFunc callback, void *user_data)
{ {

@ -755,9 +755,9 @@ static bool seq_write_data_cb(Sequence *seq, void *userdata)
BlendWriter *writer = (BlendWriter *)userdata; BlendWriter *writer = (BlendWriter *)userdata;
BLO_write_struct(writer, Sequence, seq); BLO_write_struct(writer, Sequence, seq);
if (seq->strip && seq->strip->done == 0) { if (seq->strip && seq->strip->done == 0) {
/* write strip with 'done' at 0 because readfile */ /* Write strip with 'done' at 0 because read-file. */
// TODO this doesn't depend on the `Strip` data to be present? /* TODO this doesn't depend on the `Strip` data to be present? */
if (seq->effectdata) { if (seq->effectdata) {
switch (seq->type) { switch (seq->type) {
case SEQ_TYPE_COLOR: case SEQ_TYPE_COLOR: