Cleanup: spelling in comments

This commit is contained in:
Campbell Barton
2024-08-20 14:25:52 +10:00
parent 7045fb6593
commit 908d004fcc
9 changed files with 18 additions and 18 deletions

View File

@@ -914,7 +914,7 @@ void BKE_packedfile_blend_read(BlendDataReader *reader, PackedFile **pf_p, Strin
/* NOTE: there is no way to handle endianness switch here. */
pf->sharing_info = BLO_read_shared(reader, &pf->data, [&]() {
BLO_read_data_address(reader, &pf->data);
/* Do not create an inplicit sharing if read data pointer is `nullptr`. */
/* Do not create an implicit sharing if read data pointer is `nullptr`. */
return pf->data ? blender::implicit_sharing::info_for_mem_free(const_cast<void *>(pf->data)) :
nullptr;
});

View File

@@ -44,8 +44,8 @@ namespace blender {
*
* \note: #ConcurrentMap does not support iteration over all values.
*
* This is a thin wrapper around tbb::concurrent_hash_map that also has a fallback implemention if
* TBB is not available. The fallback implementation is not optimized for performance. It mainly
* This is a thin wrapper around #tbb::concurrent_hash_map that also has a fallback implementation
* if TBB is not available. The fallback implementation is not optimized for performance. It mainly
* intends to be a simple implementation that can compile whenever the TBB variant can compile.
*/
template<typename Key,
@@ -82,7 +82,7 @@ class ConcurrentMap {
* may have write access to it at a time. The looked up value can be accessed through the
* accessor.
*
* \return True if the lookup was successfull.
* \return True if the lookup was successful.
*/
bool lookup(MutableAccessor &accessor, const Key &key)
{

View File

@@ -36,7 +36,7 @@ class GenericKey {
virtual bool equal_to(const GenericKey &other) const = 0;
/**
* For efficieny, it can be good to not always allocate the key if it's just used for lookup.
* For efficiency, it can be good to not always allocate the key if it's just used for lookup.
* This method allows the key to be converted into a heap-allocated version that can be stored
* safely if necessary.
*/

View File

@@ -257,7 +257,7 @@ void Instance::draw(Manager &manager)
View view("OverlayView", view_legacy);
if (state.xray_enabled) {
/* For Xray we render the scene to a separate depth buffer. */
/* For X-ray we render the scene to a separate depth buffer. */
resources.xray_depth_tx.acquire(render_size, GPU_DEPTH_COMPONENT24);
resources.depth_target_tx.wrap(resources.xray_depth_tx);
}

View File

@@ -281,7 +281,7 @@ struct Resources : public select::SelectMap {
/**
* Depth target.
* Can either be default depth buffer texture from #DefaultTextureList
* or `xray_depth_tx` if Xray is enabled.
* or `xray_depth_tx` if X-ray is enabled.
*/
TextureRef depth_target_tx;

View File

@@ -97,7 +97,7 @@ void enable_ex(Main &bmain, Depsgraph &depsgraph, Object &ob)
ss.bm_log = BM_log_create(ss.bm);
/* Update dependency graph, so modifiers that depend on dyntopo being enabled
* are re-evaluated and the bke::pbvh::Tree is re-created. */
* are re-evaluated and the #bke::pbvh::Tree is re-created. */
DEG_id_tag_update(&ob.id, ID_RECALC_GEOMETRY);
BKE_scene_graph_update_tagged(&depsgraph, &bmain);
}
@@ -152,7 +152,7 @@ static void disable(
BKE_ptcache_object_reset(&scene, &ob, PTCACHE_RESET_OUTDATED);
/* Update dependency graph, so modifiers that depend on dyntopo being enabled
* are re-evaluated and the bke::pbvh::Tree is re-created. */
* are re-evaluated and the #bke::pbvh::Tree is re-created. */
DEG_id_tag_update(&ob.id, ID_RECALC_GEOMETRY);
BKE_scene_graph_update_tagged(&depsgraph, &bmain);
}

View File

@@ -59,17 +59,17 @@ namespace detail_size {
constexpr float RELATIVE_SCALE_FACTOR = 0.4f;
/**
* Converts from Sculpt#constant_detail to the pbvh::Tree max edge length.
* Converts from Sculpt#constant_detail to the #pbvh::Tree max edge length.
*/
float constant_to_detail_size(float constant_detail, const Object &ob);
/**
* Converts from Sculpt#detail_percent to the pbvh::Tree max edge length.
* Converts from Sculpt#detail_percent to the #pbvh::Tree max edge length.
*/
float brush_to_detail_size(float brush_percent, float brush_radius);
/**
* Converts from Sculpt#detail_size to the pbvh::Tree max edge length.
* Converts from Sculpt#detail_size to the #pbvh::Tree max edge length.
*/
float relative_to_detail_size(float relative_detail,
float brush_radius,

View File

@@ -20,8 +20,8 @@ namespace blender::ed::sculpt_paint::geodesic {
/**
* Returns an array indexed by vertex index containing the geodesic distance to the closest vertex
* in the initial vertex set. The caller is responsible for freeing the array.
* Geodesic distances will only work when used with blender::bke::pbvh::Type::Mesh, for other
* types of blender::bke::pbvh::Tree it will fallback to euclidean distances to one of the initial
* Geodesic distances will only work when used with #blender::bke::pbvh::Type::Mesh, for other
* types of #blender::bke::pbvh::Tree it will fallback to euclidean distances to one of the initial
* vertices in the set.
*/
Array<float> distances_create(const Depsgraph &depsgraph,

View File

@@ -275,11 +275,11 @@ class VKDevice : public NonCopyable {
* When the active thread has a context a discard pool associated to the thread is returned.
* When there is no context the orphan discard pool is returned.
*
* A thread with a context can have multiple discard pools. One for each swapchain image.
* A thread with a context can have multiple discard pools. One for each swap-chain image.
* A thread without a context is most likely a discarded resource triggered during dependency
* graph update. A deps graph update from the viewport during playback or editing; or a deps
* graph update when rendering. These can happen from a different thread which will don't have a
* context at all.
* graph update. A dependency graph update from the viewport during playback or editing;
* or a dependency graph update when rendering.
* These can happen from a different thread which will don't have a context at all.
*/
VKDiscardPool &discard_pool_for_current_thread();