Cleanup: spelling in comments

This commit is contained in:
Campbell Barton
2024-01-14 11:42:50 +11:00
parent 6e9e1557bb
commit 4e898dd944
5 changed files with 15 additions and 14 deletions

View File

@@ -182,7 +182,7 @@ static void collection_free_data(ID *id)
BLI_freelistN(&collection->children);
BLI_freelistN(&collection->runtime.parents);
/* No need for depsgraph taging here, since the data is being deleted. */
/* No need for depsgraph tagging here, since the data is being deleted. */
collection_object_cache_free(nullptr, collection, LIB_ID_CREATE_NO_DEG_TAG, 0);
}
@@ -844,15 +844,15 @@ static void collection_object_cache_free(const Main *bmain,
BLI_freelistN(&collection->runtime.object_cache);
BLI_freelistN(&collection->runtime.object_cache_instanced);
/* Although it may seem abusive to call depsgraph updates from this util function, it is called
* from any codepath modifying the collections hierarchy and/or their objects. Including the
* reversed-hierarchy walked by #collection_object_cache_free_parent_recursive.
/* Although it may seem abusive to call depsgraph updates from this utility function,
* it is called from any code-path modifying the collections hierarchy and/or their objects.
* Including the reversed-hierarchy walked by #collection_object_cache_free_parent_recursive.
*
* Plus, the main reason to tag the hierarchy of parents for deg update is because their object
* caches are being freed.
*
* Having this code here avoids the need for another util tagging function processing the parent
* hierarchy as well. */
* Having this code here avoids the need for another utility tagging function processing the
* parent hierarchy as well. */
if (id_recalc_flag && (id_create_flag & (LIB_ID_CREATE_NO_MAIN | LIB_ID_CREATE_NO_DEG_TAG)) == 0)
{
BLI_assert(bmain != nullptr);

View File

@@ -1014,7 +1014,7 @@ BLI_STATIC_ASSERT_ALIGN(ShadowSceneData, 16)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Lightprobe Sphere
/** \name Light-probe Sphere
* \{ */
struct ReflectionProbeLowFreqLight {
@@ -1399,7 +1399,7 @@ static inline float3 burley_eval(float3 d, float r)
/** \} */
/* -------------------------------------------------------------------- */
/** \name Lightprobe Planar Data
/** \name Light-probe Planar Data
* \{ */
struct ProbePlanarData {

View File

@@ -145,7 +145,7 @@ static void finish_curve_or_full_copy(int &curve_index,
is_first_selected);
}
else {
/* Copy full curve if previous selected point vas not on this curve. */
/* Copy full curve if previous selected point was not on this curve. */
const int first = offsets[curve_index];
curve_interval_ranges[curve_index] = IndexRange(interval_offset, 1);
is_first_selected[curve_index] = false;

View File

@@ -1037,9 +1037,10 @@ struct ShaderCreateInfo {
/** \} */
/* -------------------------------------------------------------------- */
/** \name API-specific parameters.
* Optional parameters exposed by specific backends to enable additional features and performance
* tuning.
/** \name API-Specific Parameters
*
* Optional parameters exposed by specific back-ends to enable additional features and
* performance tuning.
* NOTE: These functions can be exposed as a pass-through on unsupported configurations.
* \{ */

View File

@@ -277,7 +277,7 @@ bool MTLShader::finalize(const shader::ShaderCreateInfo *info)
}
/** Extract desired custom parameters from CreateInfo. */
/* Tuning paramters for compute kernels. */
/* Tuning parameters for compute kernels. */
if (is_compute) {
int threadgroup_tuning_param = info->mtl_max_threads_per_threadgroup_;
if (threadgroup_tuning_param > 0) {
@@ -1541,7 +1541,7 @@ MTLComputePipelineStateInstance *MTLShader::bake_compute_pipeline_state(MTLConte
/* If PSO has compiled but max theoretical threads-per-threadgroup is lower than required
* dispatch size, recompile with increased limit. NOTE: This will result in a performance drop,
* ideally the source shader should be modified to reduce local register pressure, or, local
* workgroup size should be reduced.
* work-group size should be reduced.
* Similarly, the custom tuning parameter "mtl_max_total_threads_per_threadgroup" can be
* specified to a sufficiently large value to avoid this. */
if (pso) {