Cleanup: spelling in comments

This commit is contained in:
Campbell Barton
2024-10-01 09:59:33 +10:00
parent b3a9ca2ac2
commit c6fd26a3f5
14 changed files with 44 additions and 43 deletions

View File

@@ -164,8 +164,8 @@ elseif(CMAKE_COMPILER_IS_GNUCC OR (CMAKE_CXX_COMPILER_ID MATCHES "Clang"))
list(APPEND CYCLES_MATH_FLAGS "-freciprocal-math")
# Let the compiler reorder terms to save operations
list(APPEND CYCLES_MATH_FLAGS "-fassociative-math")
# Don't enable -ffinite-math-only since the BVH code relies on NaNs.
# Otherwise, we could just use -ffast-math.
# Don't enable `-ffinite-math-only` since the BVH code relies on NaNs.
# Otherwise, we could just use `-ffast-math`.
if(CMAKE_COMPILER_IS_GNUCC)
# Assume no signal trapping for better code generation.

View File

@@ -62,8 +62,8 @@ using slot_handle_t = decltype(::ActionSlot::handle);
* `Action::is_action_layered()`. Note that an empty Action is considered valid
* for both.
*
* \see AnimData::action
* \see AnimData::slot_handle
* \see #AnimData::action
* \see #AnimData::slot_handle
*/
class Action : public ::bAction {
public:
@@ -156,8 +156,8 @@ class Action : public ::bAction {
* \note This does NOT ensure the first two characters match the ID type of
* this slot. This is the caller's responsibility.
*
* \see Action::slot_name_define
* \see Action::slot_name_propagate
* \see #Action::slot_name_define
* \see #Action::slot_name_propagate
*/
void slot_name_set(Main &bmain, Slot &slot, StringRefNull new_name);
@@ -167,8 +167,8 @@ class Action : public ::bAction {
* \note This does NOT ensure the first two characters match the ID type of
* this slot. This is the caller's responsibility.
*
* \see Action::slot_name_set
* \see Action::slot_name_propagate
* \see #Action::slot_name_set
* \see #Action::slot_name_propagate
*/
void slot_name_define(Slot &slot, StringRefNull new_name);
@@ -216,7 +216,7 @@ class Action : public ::bAction {
/**
* Set the active Slot, ensuring only one Slot is flagged as the Active one.
*
* \param slot_handle if Slot::unassigned, there will not be any active slot.
* \param slot_handle if #Slot::unassigned, there will not be any active slot.
* Passing an unknown/invalid slot handle will result in no slot being active.
*/
void slot_active_set(slot_handle_t slot_handle);
@@ -385,7 +385,7 @@ class Action : public ::bAction {
* This ensures that the first two characters match the ID type of
* this slot.
*
* \see Action::slot_name_propagate
* \see #Action::slot_name_propagate
*/
void slot_name_ensure_prefix(Slot &slot);
};
@@ -485,7 +485,7 @@ class Strip : public ::ActionStrip {
/**
* Remove all data belonging to the given slot.
*
* This is typically only called from Layer::slot_data_remove().
* This is typically only called from #Layer::slot_data_remove().
*/
void slot_data_remove(Action &owning_action, slot_handle_t slot_handle);
};
@@ -577,7 +577,7 @@ class Layer : public ::ActionLayer {
/**
* Remove all data belonging to the given slot.
*
* This is typically only called from Action::slot_remove().
* This is typically only called from #Action::slot_remove().
*/
void slot_data_remove(Action &owning_action, slot_handle_t slot_handle);
@@ -600,7 +600,7 @@ ENUM_OPERATORS(Layer::Flags, Layer::Flags::Enabled);
* This is called a 'slot' because it binds the animatable ID to the sub-set
* of animation data that should animate it.
*
* \see AnimData::slot_handle
* \see #AnimData::slot_handle
*/
class Slot : public ::ActionSlot {
public:
@@ -680,7 +680,7 @@ class Slot : public ::ActionSlot {
* This is a low-level function, and should only be used when calling `users(bmain)` is not
* appropriate.
*
* \see Slot::users(Main &bmain)
* \see #Slot::users(Main &bmain)
*/
Vector<ID *> runtime_users();
@@ -707,7 +707,7 @@ class Slot : public ::ActionSlot {
*
* \note This static method invalidates all user caches of all Action Slots.
*
* \see blender::animrig::internal::rebuild_slot_user_cache()
* \see #blender::animrig::internal::rebuild_slot_user_cache()
*/
static void users_invalidate(Main &bmain);
@@ -783,7 +783,7 @@ class StripKeyframeData : public ::ActionStripKeyframeData {
/**
* Remove all strip data for the given slot.
*
* Typically only called from Strip::slot_data_remove().
* Typically only called from #Strip::slot_data_remove().
*/
void slot_data_remove(slot_handle_t slot_handle);
@@ -1138,7 +1138,7 @@ static_assert(sizeof(ChannelGroup) == sizeof(::bActionGroup),
* This is basically the same as `BKE_action_add`, except that the Action has
* zero users and it's already wrapped with its C++ wrapper.
*
* \see BKE_action_add
* \see #BKE_action_add
*/
Action &action_add(Main &bmain, StringRefNull name);
@@ -1166,7 +1166,7 @@ Action &action_add(Main &bmain, StringRefNull name);
*
* Use this function when you already have the AnimData struct of this ID.
*
* \return true when succesful, false otherwise. This can fail when the NLA is in tweak mode (no
* \return true when successful, false otherwise. This can fail when the NLA is in tweak mode (no
* action changes allowed) or when a legacy Action is assigned and it doesn't match the animated
* ID's type.
*/
@@ -1182,7 +1182,7 @@ Action &action_add(Main &bmain, StringRefNull name);
*
* Same as calling `assign_action(nullptr, animated_id)`.
*
* \see blender::animrig::assign_action(ID &animated_id)
* \see #blender::animrig::assign_action(ID &animated_id)
*/
[[nodiscard]] bool unassign_action(ID &animated_id);
@@ -1191,7 +1191,7 @@ Action &action_add(Main &bmain, StringRefNull name);
*
* Same as calling `assign_action(nullptr, owned_adt)`.
*
* \see blender::animrig::assign_action(OwnedAnimData owned_adt)
* \see #blender::animrig::assign_action(OwnedAnimData owned_adt)
*/
[[nodiscard]] bool unassign_action(OwnedAnimData owned_adt);
@@ -1315,7 +1315,7 @@ animrig::ChannelBag *channelbag_for_action_slot(Action &action, slot_handle_t sl
* \note This function requires a layered Action. To transparently handle legacy Actions, see the
* `animrig::legacy` namespace.
*
* \see blender::animrig::legacy::fcurves_for_action_slot
* \see #blender::animrig::legacy::fcurves_for_action_slot
*/
Span<FCurve *> fcurves_for_action_slot(Action &action, slot_handle_t slot_handle);
Span<const FCurve *> fcurves_for_action_slot(const Action &action, slot_handle_t slot_handle);
@@ -1356,14 +1356,14 @@ FCurve *action_fcurve_ensure(Main *bmain,
* All the Action slots are searched for this F-Curve. To limit to a single
* slot, use fcurve_find_in_action_slot().
*
* \see blender::animrig::fcurve_find_in_action_slot
* \see #blender::animrig::fcurve_find_in_action_slot
*/
FCurve *fcurve_find_in_action(bAction *act, FCurveDescriptor fcurve_descriptor);
/**
* Find the F-Curve in the given Action Slot.
*
* \see blender::animrig::fcurve_find_in_action
* \see #blender::animrig::fcurve_find_in_action
*/
FCurve *fcurve_find_in_action_slot(bAction *act,
slot_handle_t slot_handle,
@@ -1372,7 +1372,7 @@ FCurve *fcurve_find_in_action_slot(bAction *act,
/**
* Find the F-Curve in the Action Slot assigned to this ADT.
*
* \see blender::animrig::fcurve_find_in_action
* \see #blender::animrig::fcurve_find_in_action
*/
FCurve *fcurve_find_in_assigned_slot(AnimData &adt, FCurveDescriptor fcurve_descriptor);
@@ -1446,9 +1446,9 @@ void action_fcurve_attach(Action &action,
* The F-Curve must exist on the source Action. All channelbags for all slots
* are searched for the F-Curve.
*
* \param action_slot_dst may not be Slot::unassigned on layered Actions.
* \param action_slot_dst may not be #Slot::unassigned on layered Actions.
*
* \see blender::animrig::action_fcurve_detach
* \see #blender::animrig::action_fcurve_detach
*/
void action_fcurve_move(Action &action_dst,
slot_handle_t action_slot_dst,
@@ -1512,7 +1512,7 @@ ID *action_slot_get_id_best_guess(Main &bmain, Slot &slot, ID *primary_id);
* TODO: Maybe at some point this function should get extended with an ID type parameter, to return
* the first slot that is suitable for that ID type.
*
* \return The handle of the first slot, or Slot::unassigned if there is no slot (which includes
* \return The handle of the first slot, or #Slot::unassigned if there is no slot (which includes
* legacy Actions).
*/
slot_handle_t first_slot_handle(const ::bAction &dna_action);

View File

@@ -62,7 +62,7 @@ void rebuild_slot_user_cache(Main &bmain)
if (!slot) {
return true;
}
/* Const cast because the foreach produces const Actions, and I (Sybren)
/* Constant cast because the `foreach` produces const Actions, and I (Sybren)
* didn't want to make a non-const duplicate. */
const_cast<Slot *>(slot)->users_add(*id);
return true;

View File

@@ -110,7 +110,7 @@ static void id_type_init()
UNUSED_VARS_NDEBUG(init_types_num);
{ /* Inspect which ID types can be animated, so that IDType_ID_AC.dependencies_id_types can be
* set to include those. The runtime ID* cache of animrig::Slot will point to any
* set to include those. The runtime ID* cache of #animrig::Slot will point to any
* ID that is animated by it, and thus can point to any animatable ID type. */
IDType_ID_AC.dependencies_id_types = 0;
for (const IDTypeInfo *id_type : id_types) {

View File

@@ -23,9 +23,9 @@
* to be relatively fast by default in all cases. However, it also offers many customization
* points that allow it to be optimized for a specific use case.
*
* A rudimentary benchmark can be found in BLI_set_test.cc. The results of that benchmark are
* there as well. The numbers show that in this specific case blender::Set outperforms
* std::unordered_set consistently by a good amount.
* A rudimentary benchmark can be found in `BLI_set_test.cc`. The results of that benchmark are
* there as well. The numbers show that in this specific case #blender::Set outperforms
* #std::unordered_set consistently by a good amount.
*
* Some noteworthy information:
* - Key must be a movable type.

View File

@@ -299,7 +299,7 @@ PointsRange copy_point_attributes(MutableSpan<PointsRange> selected_ranges,
void copy_curve_attributes(Span<PointsRange> ranges_selected, bke::CurvesGeometry &dst_curves)
{
/* The decission of which stroke use to copy the curve attribues is a bit arbitrary, since the
/* The decision of which stroke use to copy the curve attributes is a bit arbitrary, since the
* original selection may embrace several strokes. The criteria is as follows:
* - If the selection contained points from the active layer, the first selected stroke from it
* is used.

View File

@@ -181,7 +181,7 @@ void ED_screen_draw_edges(wmWindow *win)
if (!active_area) {
LISTBASE_FOREACH (ScrArea *, area, &screen->areabase) {
AZone *zone = ED_area_actionzone_find_xy(area, win->eventstate->xy);
/* Get area from action zone, if not scrollbar. */
/* Get area from action zone, if not scroll-bar. */
if (zone && zone->type != AZONE_REGION_SCROLL) {
active_area = area;
break;

View File

@@ -240,7 +240,7 @@ struct StepData {
std::mutex nodes_mutex;
/**
* #undo::Node is stored per pbvh::Node to reduce data storage needed for changes only impacting
* #undo::Node is stored per #pbvh::Node to reduce data storage needed for changes only impacting
* small portions of the mesh. During undo step creation and brush evaluation we often need to
* look up the undo state for a specific node. That lookup must be protected by a lock since
* nodes are pushed from multiple threads. This map speeds up undo node access to reduce the

View File

@@ -229,11 +229,11 @@ struct ShaderSpecialization {
/**
* Request the compilation of multiple specialization constant variations at once,
* allowing the backend to use multithreaded compilation.
* allowing the backend to use multi-threaded compilation.
* Returns a handle that can be used to poll if all variations have been compiled.
* A NULL handle indicates no compilation of any variant was possible (likely due to
* some state being currently available) and so no batch was created. Compilation
* of the specialiized variant will instead occur at draw/dispatch time.
* of the specialized variant will instead occur at draw/dispatch time.
* NOTE: This function is asynchronous on OpenGL and Metal and a no-op on Vulkan.
* Batches are processed one by one in FIFO order.
* WARNING: Binding a specialization before the batch finishes will fail.

View File

@@ -1818,7 +1818,7 @@ bool MTLShader::has_transform_feedback_varying(std::string str)
/* Since this is going to be compiling shaders in a multi-threaded fashion we
* don't want to create an instance per context as we want to restrict the
* number of simultanenous compliation threads to ensure system respsonsiveness.
* number of simultaneous compilation threads to ensure system responsiveness.
* Hence the global shared instance. */
MTLParallelShaderCompiler *g_shared_parallel_shader_compiler = nullptr;
std::mutex g_shared_parallel_shader_compiler_mutex;
@@ -1893,7 +1893,7 @@ void MTLParallelShaderCompiler::create_compile_threads()
id<MTLDevice> metal_device = metal_context->device;
#if defined(MAC_OS_VERSION_13_3)
/* Clamp the number of threads if neccessary. */
/* Clamp the number of threads if necessary. */
if (@available(macOS 13.3, *)) {
/* Check we've set the flag to allow more than 2 compile threads. */
BLI_assert(metal_device.shouldMaximizeConcurrentCompilation);
@@ -2120,7 +2120,7 @@ SpecializationBatchHandle MTLParallelShaderCompiler::precompile_specializations(
* We don't have the relevant info to create a Render PSO Descriptor unless
* the shader has a has_parent_shader() but in that case it would (currently) be
* invalid to apply specialization constants. For those reasons we currently only
* support precompilation of Compute shaders.
* support pre-compilation of Compute shaders.
* (technically we could call makeFunction but the benefit would likely be minimal) */
if (!sh->has_compute_shader_lib()) {
continue;

View File

@@ -5,7 +5,7 @@
/** \file
* \ingroup gpu
*
* GL implementation of gpu::Batch.
* GL implementation of #gpu::Batch.
* The only specificity of GL here is that it caches a list of
* Vertex Array Objects based on the bound shader interface.
*/

View File

@@ -48,7 +48,7 @@ enum class OutputSocketFieldType {
};
/**
* A bit-field that maps to the realtime_compositor::InputRealizationOptions.
* A bit-field that maps to the #realtime_compositor::InputRealizationOptions.
*/
enum class CompositorInputRealizationOptions : uint8_t {
None = 0,

View File

@@ -192,7 +192,7 @@ PyObject *pyrna_struct_CreatePyObject_with_primitive_support(PointerRNA *ptr);
PyObject *pyrna_struct_CreatePyObject(PointerRNA *ptr);
PyObject *pyrna_prop_CreatePyObject(PointerRNA *ptr, PropertyRNA *prop);
/* extern'd by other modules which don't deal closely with RNA */
/* Made public for other modules which don't deal closely with RNA. */
PyObject *pyrna_id_CreatePyObject(ID *id);
bool pyrna_id_FromPyObject(PyObject *obj, ID **id);
bool pyrna_id_CheckPyObject(PyObject *obj);

View File

@@ -578,6 +578,7 @@ dict_custom = {
"multithreaded",
"multithreading",
"namespace",
"namespaces",
"reparent",
"tooltip",
"unparent",