Cleanup: use uppercase tags, following own style guide

This commit is contained in:
Campbell Barton 2024-05-03 11:32:43 +10:00
parent 5529a94f14
commit 9918488bb1
67 changed files with 90 additions and 90 deletions

@ -768,7 +768,7 @@ template<typename Mesh> class Mikktspace {
return;
}
/* Todo: Vectorize?
/* TODO: Vectorize?
* Also: Could add special case for flat shading, when all normals are equal half of the fCos
* projections and two of the three tangent projections are unnecessary. */
std::array<float3, 3> n, p;

@ -57,7 +57,7 @@ BoneCollection *ANIM_bonecoll_new(const char *name)
name = DATA_(bonecoll_default_name);
}
/* Note: the collection name may change after the collection is added to an
/* NOTE: the collection name may change after the collection is added to an
* armature, to ensure it is unique within the armature. */
BoneCollection *bcoll = MEM_cnew<BoneCollection>(__func__);
@ -153,7 +153,7 @@ static void bonecoll_ensure_name_unique(bArmature *armature, BoneCollection *bco
/**
* Inserts bcoll into armature's array of bone collections at index.
*
* Note: the specified index is where the given bone collection will end up.
* NOTE: the specified index is where the given bone collection will end up.
* This means, for example, that for a collection array of length N, you can
* pass N as the index to append to the end.
*/
@ -668,7 +668,7 @@ void ANIM_armature_bonecoll_remove_from_index(bArmature *armature, int index)
/* Rotate the to-be-removed collection to the last array element. */
internal::bonecolls_move_to_index(armature, index, armature->collection_array_num - 1);
/* Note: we don't bother to shrink the allocation. It's okay if the
/* NOTE: we don't bother to shrink the allocation. It's okay if the
* capacity has extra space, because the number of valid items is tracked. */
armature->collection_array_num--;
armature->collection_array[armature->collection_array_num] = nullptr;

@ -165,7 +165,7 @@ class LayerGroup;
class Layer;
/* Defines the common functions used by #TreeNode, #Layer, and #LayerGroup.
* Note: Because we cannot mix C-style and C++ inheritance (all of these three classes wrap a
* NOTE: Because we cannot mix C-style and C++ inheritance (all of these three classes wrap a
* C-struct that already uses "inheritance"), we define and implement these methods on all these
* classes individually. This just means that we can call `layer->name()` directly instead of
* having to write `layer->as_node().name()`. For #Layer and #LayerGroup the calls are just
@ -832,7 +832,7 @@ class GreasePencilEditHints {
/**
* Array of #GreasePencilDrawingEditHints. There is one edit hint for each evaluated drawing.
* Note: The index for each element is the layer index.
* \note The index for each element is the layer index.
*/
std::optional<Array<GreasePencilDrawingEditHints>> drawing_hints;
};

@ -106,7 +106,7 @@ struct bNodeSocketStaticTypeInfo {
const char *label;
};
/* Note: Socket and interface subtypes could be defined from a single central list,
/* NOTE: Socket and interface subtypes could be defined from a single central list,
* but makesrna cannot have a dependency on BKE, so this list would have to live in RNA itself,
* with BKE etc. accessing the RNA API to get the subtypes info. */
static const bNodeSocketStaticTypeInfo node_socket_subtypes[] = {

@ -187,7 +187,7 @@ bool bmesh_node_raycast_detail(PBVHNode *node,
* For orthographic cameras, project the far away ray segment points to the root node so
* we can have better precision.
*
* Note: the interval is not guaranteed to lie between ray_start and ray_end; this is
* \note the interval is not guaranteed to lie between ray_start and ray_end; this is
* not necessary for orthographic views and is impossible anyhow due to the necessity of
* projecting the far clipping plane into the local object space. This works out to
* dividing view3d->clip_end by the object scale, which for small object and large

@ -97,7 +97,7 @@ static void armature_init_data(ID *id)
* Copies the bone collection in `bcoll_src` to `bcoll_dst`, re-hooking up all
* of the bone relationships to the bones in `armature_dst`.
*
* Note: this function's use case is narrow in scope, intended only for use in
* \note this function's use case is narrow in scope, intended only for use in
* `armature_copy_data()` below. You probably don't want to use this otherwise.
*
* \param lib_id_flag: Copying options (see BKE_lib_id.hh's LIB_ID_COPY_... flags for more).

@ -1048,7 +1048,7 @@ static ComponentAttributeProviders create_attribute_providers_for_mesh()
nullptr,
AttributeValidator{&int2_index_clamp});
/* Note: This clamping is more of a last resort, since it's quite easy to make an
/* NOTE: This clamping is more of a last resort, since it's quite easy to make an
* invalid mesh that will crash Blender by arbitrarily editing this attribute. */
static const auto int_index_clamp = mf::build::SI1_SO<int, int>(
"Index Validate",

@ -953,7 +953,7 @@ Layer::Layer(const Layer &other) : Layer()
this->set_view_layer_name(other.viewlayername);
/* Note: We do not duplicate the frame storage since it is only needed for writing to file. */
/* NOTE: We do not duplicate the frame storage since it is only needed for writing to file. */
this->runtime->frames_ = other.runtime->frames_;
this->runtime->sorted_keys_cache_ = other.runtime->sorted_keys_cache_;
/* Tag the frames map, so the frame storage is recreated once the DNA is saved. */
@ -2258,7 +2258,7 @@ void GreasePencil::remove_drawings_with_no_users()
auto is_drawing_used = [&](const int drawing_index) {
GreasePencilDrawingBase *drawing_base = drawings[drawing_index];
/* Note: GreasePencilDrawingReference does not have a user count currently, but should
/* NOTE: GreasePencilDrawingReference does not have a user count currently, but should
* eventually be counted like GreasePencilDrawing. */
if (drawing_base->type != GP_DRAWING) {
return false;

@ -1234,7 +1234,7 @@ static void legacy_object_thickness_modifier_thickness_anim(ConversionData &conv
return;
}
/* Note: At this point, the animation was already transferred to the destination object. Now we
/* NOTE: At this point, the animation was already transferred to the destination object. Now we
* just need to convert the fcurve data to be in the right space. */
AnimDataConvertor animdata_convert_thickness(
conversion_data,
@ -1329,7 +1329,7 @@ static void layer_adjustments_to_modifiers(ConversionData &conversion_data,
if (has_thickness_adjustment) {
/* Convert the "pixel" offset value into a radius value.
* GPv2 used a conversion of 1 "px" = 0.001. */
/* Note: this offset may be negative. */
/* NOTE: this offset may be negative. */
const float radius_offset = float(thickness_px) * LEGACY_RADIUS_CONVERSION_FACTOR;
const auto offset_radius_ntree_ensure = [&](Library *owner_library) {
@ -1904,7 +1904,7 @@ static void legacy_object_modifier_multiply(ConversionData &conversion_data,
md_multiply.fading_thickness = legacy_md_multiply.fading_thickness;
md_multiply.fading_opacity = legacy_md_multiply.fading_opacity;
/* Note: This looks wrong, but GPv2 version uses Mirror modifier flags in its `flag` property
/* NOTE: This looks wrong, but GPv2 version uses Mirror modifier flags in its `flag` property
* and own flags in its `flags` property. */
legacy_object_modifier_influence(md_multiply.influence,
legacy_md_multiply.layername,
@ -2360,7 +2360,7 @@ static void legacy_object_modifier_time(ConversionData &conversion_data,
dst_segment.segment_repeat = src_segment.seg_repeat;
}
/* Note: GPv2 time modifier has a material pointer but it is unused. */
/* NOTE: GPv2 time modifier has a material pointer but it is unused. */
legacy_object_modifier_influence(md_time.influence,
legacy_md_time.layername,
legacy_md_time.layer_pass,

@ -20,7 +20,7 @@ namespace blender::bke::greasepencil::tests {
/* --------------------------------------------------------------------------------------------- */
/* Grease Pencil ID Tests. */
/* Note: Using a struct with constructor and destructor instead of a fixture here, to have all the
/* NOTE: Using a struct with constructor and destructor instead of a fixture here, to have all the
* tests in the same group (`greasepencil`). */
struct GreasePencilIDTestContext {
Main *bmain = nullptr;

@ -1400,7 +1400,7 @@ static void IDP_DirectLinkProperty(IDProperty *prop, BlendDataReader *reader);
static void read_ui_data(IDProperty *prop, BlendDataReader *reader)
{
/* Note: null UI data can happen when opening more recent files with unknown types of
/* NOTE: null UI data can happen when opening more recent files with unknown types of
* IDProperties. */
switch (IDP_ui_data_type(prop)) {

@ -1498,8 +1498,8 @@ void BKE_libblock_copy_in_lib(Main *bmain,
if (is_embedded_id && (orig_flag & LIB_ID_CREATE_NO_MAIN) == 0) {
new_id->tag &= ~LIB_TAG_NO_MAIN;
}
/* Note: This also needs to run for ShapeKeys, which are not (yet) actual embedded IDs.
* Note: for now, keep existing owner ID (i.e. owner of the source embedded ID) if no new one
/* NOTE: This also needs to run for ShapeKeys, which are not (yet) actual embedded IDs.
* NOTE: for now, keep existing owner ID (i.e. owner of the source embedded ID) if no new one
* is given. In some cases (e.g. depsgraph), this is important for later remapping to work
* properly.
*/

@ -914,7 +914,7 @@ static void ntree_blend_write(BlendWriter *writer, ID *id, const void *id_addres
if (!BLO_write_is_undo(writer)) {
/* Generate legacy inputs/outputs socket ListBase for forward compatibility.
* Note: this has to happen before writing the ntree struct itself so that the ListBase
* NOTE: this has to happen before writing the ntree struct itself so that the ListBase
* first/last pointers are valid. */
blender::bke::forward_compat::construct_interface_as_legacy_sockets(ntree);
}

@ -276,7 +276,7 @@ static void socket_data_copy_ptr(bNodeTreeInterfaceSocket &dst,
/** \name Write Socket Data to Blend File
* \{ */
/* Note: no default implementation, every used type must write at least the base struct. */
/* NOTE: no default implementation, every used type must write at least the base struct. */
inline void socket_data_write_impl(BlendWriter *writer, bNodeSocketValueFloat &data)
{
@ -1393,7 +1393,7 @@ bool bNodeTreeInterface::move_item_to_parent(bNodeTreeInterfaceItem &item,
}
}
else {
/* Note: only remove and reinsert when parents different, otherwise removing the item can
/* NOTE: only remove and reinsert when parents different, otherwise removing the item can
* change the desired target position! */
if (parent->remove_item(item, false)) {
new_parent->insert_item(item, new_position);

@ -1351,7 +1351,7 @@ TEST(path_util, HasHiddenComponents)
EXPECT_FALSE(BLI_path_has_hidden_component("a."));
EXPECT_FALSE(BLI_path_has_hidden_component("a./b."));
/* Note: path component that is just a dot is not considered hidden. */
/* NOTE: path component that is just a dot is not considered hidden. */
EXPECT_FALSE(BLI_path_has_hidden_component("."));
EXPECT_FALSE(BLI_path_has_hidden_component("a/."));
EXPECT_FALSE(BLI_path_has_hidden_component("a\\."));

@ -3040,7 +3040,7 @@ static BHead *read_global(BlendFileData *bfd, FileData *fd, BHead *bhead)
bfd->fileflags = fg->fileflags;
bfd->globalf = fg->globalf;
/* Note: since 88b24bc6bb, `fg->filepath` is only written for crash recovery and autosave files,
/* NOTE: since 88b24bc6bb, `fg->filepath` is only written for crash recovery and autosave files,
* so only overwrite `fd->relabase` if it is not empty, in case a regular blendfile is opened
* through one of the 'recover' operators.
*

@ -1060,7 +1060,7 @@ static bNodeSocket *version_make_socket_stub(const char *idname,
socket->storage = nullptr;
socket->flag |= SOCK_COLLAPSED;
/* Note: technically socket values can store ref-counted ID pointers, but at this stage the
/* NOTE: technically socket values can store ref-counted ID pointers, but at this stage the
* refcount can be ignored. It gets recomputed after lib-linking for all ID pointers. Socket
* values don't have allocated data, so a simple duplication works here. */
socket->default_value = default_value ? MEM_dupallocN(default_value) : nullptr;

@ -31,7 +31,7 @@ void SummedAreaTableOperation::update_memory_buffer(MemoryBuffer *output,
const rcti &area,
Span<MemoryBuffer *> inputs)
{
/* Note: although this is a single threaded call, multithreading is used. */
/* NOTE: although this is a single threaded call, multithreading is used. */
MemoryBuffer *image = inputs[0];
/* First pass: copy input to output and sum horizontally. */
@ -85,7 +85,7 @@ float4 summed_area_table_sum(MemoryBuffer *buffer, const rcti &area)
* a b
* x
*
* Note: this is the same definition as in https://en.wikipedia.org/wiki/Summed-area_table
* NOTE: this is the same definition as in https://en.wikipedia.org/wiki/Summed-area_table
* but using the blender convention with the origin being at the lower left.
*/

@ -125,7 +125,7 @@ void raytrace_resolve(ClosureInputGlossy cl_in,
inout ClosureEvalCommon cl_common,
inout ClosureOutputGlossy cl_out)
{
/* Note: Reflection samples declared in function scope to avoid per-thread memory pressure on
/* NOTE: Reflection samples declared in function scope to avoid per-thread memory pressure on
* tile-based GPUs e.g. Apple Silicon. */
const SAMPLE_STORAGE_TYPE resolve_sample_offsets[36] = SAMPLE_STORAGE_TYPE[36](
/* Set 1. */
@ -257,7 +257,7 @@ void main()
* diverge and only the final result is masked. */
factor = 0.0f;
#else
/* Note: In the Metal API, prior to Metal 2.3, Discard is not an explicit return and can
/* NOTE: In the Metal API, prior to Metal 2.3, Discard is not an explicit return and can
* produce undefined behavior. This is especially prominent with derivatives if control-flow
* divergence is present.
*

@ -205,7 +205,7 @@ void Instance::begin_sync()
if (is_light_bake) {
/* Do not use render layer visibility during bake.
* Note: This is arbitrary and could be changed if needed. */
* NOTE: This is arbitrary and could be changed if needed. */
use_surfaces = use_curves = use_volumes = true;
}

@ -337,7 +337,7 @@ void ShadowPunctual::compute_projection_boundaries(eLightType light_type,
* Alpha: FOT angle.
* Beta: OTN angle.
*
* Note: FTO, ONT and TNI are right angles.
* NOTE: FTO, ONT and TNI are right angles.
*/
float cos_alpha = shadow_radius / max_lit_distance;
float sin_alpha = sqrt(1.0f - math::square(cos_alpha));
@ -500,7 +500,7 @@ IndexRange ShadowDirectional::cascade_level_range(const Camera &camera, float lo
/* Tile-maps "rotate" around the first one so their effective range is only half their size. */
float per_tilemap_coverage = ShadowDirectional::coverage_get(lod_level) * 0.5f;
/* Number of tile-maps needed to cover the whole view. */
/* Note: floor + 0.5 to avoid 0 when parallel. */
/* NOTE: floor + 0.5 to avoid 0 when parallel. */
int tilemap_len = ceil(0.5f + depth_range_in_shadow_space / per_tilemap_coverage);
return IndexRange(lod_level, tilemap_len);
}

@ -59,7 +59,7 @@ void main()
stack.cl[0] = closure_light_new(cl_transmit, V, gbuf.thickness);
/* Note: Only evaluates `stack.cl[0]`. */
/* NOTE: Only evaluates `stack.cl[0]`. */
light_eval_transmission(stack, P, Ng, V, vPz, gbuf.thickness);
# if 1 /* TODO Limit to SSS. */

@ -52,7 +52,7 @@ void forward_lighting_eval(float thickness, out vec3 radiance, out vec3 transmit
stack.cl[0] = closure_light_new(cl_transmit, V, thickness);
/* Note: Only evaluates `stack.cl[0]`. */
/* NOTE: Only evaluates `stack.cl[0]`. */
light_eval_transmission(stack, g_data.P, surface_N, V, vPz, thickness);
# if defined(MAT_SUBSURFACE)

@ -27,14 +27,14 @@
*
* \{ */
/* Note: Only specialized for the gbuffer pass. */
/* NOTE: Only specialized for the gbuffer pass. */
#ifndef GBUFFER_LAYER_MAX
# define GBUFFER_LAYER_MAX 3
#endif
#define GBUFFER_NORMAL_MAX (GBUFFER_LAYER_MAX + /* Additional data */ 1)
#define GBUFFER_DATA_MAX (GBUFFER_LAYER_MAX * 2)
#define GBUFFER_HEADER_BITS_PER_LAYER 4
/* Note: Reserve the last 4 bits for the normal layers ids. */
/* NOTE: Reserve the last 4 bits for the normal layers ids. */
#define GBUFFER_NORMAL_BITS_SHIFT 12
struct GBufferData {
@ -867,7 +867,7 @@ GBufferWriter gbuffer_pack(GBufferData data_in)
/* Return the number of closure as encoded in the given header value. */
int gbuffer_closure_count(uint header)
{
/* Note: Need to be adjusted for different global GBUFFER_LAYER_MAX. */
/* NOTE: Need to be adjusted for different global GBUFFER_LAYER_MAX. */
const uint bits_per_layer = uint(GBUFFER_HEADER_BITS_PER_LAYER);
uvec3 closure_types = (uvec3(header) >> (uvec3(0u, 1u, 2u) * bits_per_layer)) &
((1u << bits_per_layer) - 1);
@ -876,7 +876,7 @@ int gbuffer_closure_count(uint header)
bool gbuffer_has_transmission(uint header)
{
/* Note: Need to be adjusted for different global GBUFFER_LAYER_MAX. */
/* NOTE: Need to be adjusted for different global GBUFFER_LAYER_MAX. */
const uint bits_per_layer = uint(GBUFFER_HEADER_BITS_PER_LAYER);
const uint header_mask = (GBUF_TRANSMISSION_BIT << (bits_per_layer * 0)) |
(GBUF_TRANSMISSION_BIT << (bits_per_layer * 1)) |

@ -87,7 +87,7 @@ void main()
/* Write the occupancy bits */
for (int i = 0; i < imageSize(occupancy_img).z; i++) {
if (occupancy.bits[i] != 0u) {
/* Note: Doesn't have to be atomic but we need to blend with other method. */
/* NOTE: Doesn't have to be atomic but we need to blend with other method. */
imageAtomicOr(occupancy_img, ivec3(texel, i), occupancy.bits[i]);
}
}

@ -182,7 +182,7 @@ float shadow_punctual_level_fractional(LightData light,
{
float ratio = shadow_punctual_pixel_ratio(
light, lP, is_perspective, distance_to_camera, film_pixel_radius);
/* Note: Bias by one to counteract the ceil in the `int` variant. This is done because this
/* NOTE: Bias by one to counteract the ceil in the `int` variant. This is done because this
* function should return an upper bound. */
float lod = -log2(ratio) - 1.0 + light.lod_bias;
lod = clamp(lod, 0.0, float(SHADOW_TILEMAP_LOD));

@ -174,7 +174,7 @@ vec3 shadow_clip_vector_get(vec3 view_position, float clip_distance_inv)
if (clip_distance_inv < 0.0) {
/* Area light side projections. Clip using the up axis (which maps to light -Z). */
/* Note: clip_distance_inv should already be scaled by M_SQRT3. */
/* NOTE: clip_distance_inv should already be scaled by M_SQRT3. */
return vec3(view_position.y * clip_distance_inv);
}
/* Sphere light case. */

@ -188,7 +188,7 @@ void eval_volume_step(inout vec3 Lscat, float extinction, float step_len, out fl
vec4 volume_integration(vec3 ray_ori, vec3 ray_dir, float ray_inc, float ray_max, float step_len)
{
/* Note: Constant array declared inside function scope to reduce shader core thread memory
/* NOTE: Constant array declared inside function scope to reduce shader core thread memory
* pressure on Apple Silicon. */
const vec4 dither_mat[4] = vec4[4](vec4(P(0.0), P(8.0), P(2.0), P(10.0)),
vec4(P(12.0), P(4.0), P(14.0), P(6.0)),

@ -555,7 +555,7 @@ static bool mesh_batch_cache_valid(Object *object, Mesh *mesh)
return false;
}
/* Note: PBVH draw data should not be checked here. */
/* NOTE: PBVH draw data should not be checked here. */
if (cache->is_editmode != (mesh->runtime->edit_mesh != nullptr)) {
return false;

@ -1210,7 +1210,7 @@ static void test_eevee_shadow_tilemap_amend()
tilemap_data.fill(0);
auto pixel_get = [&](int x, int y, int tilemap_index) -> uint32_t & {
/* Note: assumes that tilemap_index is < SHADOW_TILEMAP_PER_ROW. */
/* NOTE: assumes that tilemap_index is < SHADOW_TILEMAP_PER_ROW. */
return tilemap_data[y * SHADOW_TILEMAP_RES * SHADOW_TILEMAP_PER_ROW + x +
tilemap_index * SHADOW_TILEMAP_RES];
};
@ -1282,7 +1282,7 @@ static void test_eevee_shadow_tilemap_amend()
std::string result = "";
for (auto y : IndexRange(SHADOW_TILEMAP_RES)) {
for (auto x : IndexRange(SHADOW_TILEMAP_RES)) {
/* Note: assumes that tilemap_index is < SHADOW_TILEMAP_PER_ROW. */
/* NOTE: assumes that tilemap_index is < SHADOW_TILEMAP_PER_ROW. */
int tile_ofs = y * SHADOW_TILEMAP_RES * SHADOW_TILEMAP_PER_ROW + x +
tilemap_index * SHADOW_TILEMAP_RES;
ShadowSamplingTile tile = shadow_sampling_tile_unpack(pixels[tile_ofs]);
@ -1303,7 +1303,7 @@ static void test_eevee_shadow_tilemap_amend()
std::string result = "";
for (auto y : IndexRange(SHADOW_TILEMAP_RES)) {
for (auto x : IndexRange(SHADOW_TILEMAP_RES)) {
/* Note: assumes that tilemap_index is < SHADOW_TILEMAP_PER_ROW. */
/* NOTE: assumes that tilemap_index is < SHADOW_TILEMAP_PER_ROW. */
int tile_ofs = y * SHADOW_TILEMAP_RES * SHADOW_TILEMAP_PER_ROW + x +
tilemap_index * SHADOW_TILEMAP_RES;
ShadowSamplingTile tile = shadow_sampling_tile_unpack(pixels[tile_ofs]);
@ -1324,7 +1324,7 @@ static void test_eevee_shadow_tilemap_amend()
std::string result = "";
for (auto y : IndexRange(SHADOW_TILEMAP_RES)) {
for (auto x : IndexRange(SHADOW_TILEMAP_RES)) {
/* Note: assumes that tilemap_index is < SHADOW_TILEMAP_PER_ROW. */
/* NOTE: assumes that tilemap_index is < SHADOW_TILEMAP_PER_ROW. */
int tile_ofs = y * SHADOW_TILEMAP_RES * SHADOW_TILEMAP_PER_ROW + x +
tilemap_index * SHADOW_TILEMAP_RES;
ShadowSamplingTile tile = shadow_sampling_tile_unpack(pixels[tile_ofs]);

@ -142,7 +142,7 @@ static AssetShelf *update_active_shelf(const bContext &C,
RegionAssetShelf &shelf_regiondata,
FunctionRef<void(AssetShelf &new_shelf)> on_create)
{
/* Note: Don't access #AssetShelf.type directly, use #type_ensure(). */
/* NOTE: Don't access #AssetShelf.type directly, use #type_ensure(). */
/* Case 1: */
if (shelf_regiondata.active_shelf &&

@ -461,7 +461,7 @@ static int run_node_group_exec(bContext *C, wmOperator *op)
Main *bmain = CTX_data_main(C);
Scene *scene = CTX_data_scene(C);
Object *active_object = CTX_data_active_object(C);
/* Note: `region` and `rv3d` may be null when called from a script. */
/* NOTE: `region` and `rv3d` may be null when called from a script. */
const ARegion *region = CTX_wm_region(C);
const RegionView3D *rv3d = CTX_wm_region_view3d(C);
if (!active_object) {

@ -2576,7 +2576,7 @@ static bke::CurvesGeometry extrude_grease_pencil_curves(const bke::CurvesGeometr
selection.finish();
/* Cyclic attribute : newly created curves cannot be cyclic.
* Note: if the cyclic attribute is single and false, it can be kept this way.
* NOTE: if the cyclic attribute is single and false, it can be kept this way.
*/
if (src_cyclic.get_if_single().value_or(true)) {
dst.cyclic_for_write().drop_front(old_curves_num).fill(false);

@ -1573,7 +1573,7 @@ namespace blender::interface::internal {
/**
* Get the driver(s) of the given property.
*
* Note: intended to be used in conjunction with `paste_property_drivers()` below.
* \note intended to be used in conjunction with `paste_property_drivers()` below.
*
* \param ptr: The RNA pointer of the property.
* \param prop: The property RNA of the property.
@ -1600,7 +1600,7 @@ blender::Vector<FCurve *> get_property_drivers(
* property, just some elements of an array property, or a single driver for a
* non-array property.
*
* Note: intended to be used in conjunction with `get_property_drivers()` above.
* \note intended to be used in conjunction with `get_property_drivers()` above.
* The destination property should have the same type and (if an array property)
* length as the source property passed to `get_property_drivers()`.
*

@ -1594,7 +1594,7 @@ blender::Vector<FCurve *> get_property_drivers(
blender::Vector<FCurve *> drivers = {};
const bool is_array_prop = RNA_property_array_check(prop);
if (!is_array_prop) {
/* Note: by convention Blender assigns 0 as the index for drivers of
/* NOTE: by convention Blender assigns 0 as the index for drivers of
* non-array properties, which is why we search for it here. Values > 0 are
* not recognized by Blender's driver system in that case. Values < 0 are
* recognized for driver evaluation, but `BKE_fcurve_find()` unconditionally

@ -290,7 +290,7 @@ struct EraseOperationExecutor {
const int64_t squared_distance = math::distance_squared(
this->mouse_position_pixels, screen_space_positions_pixel[src_point]);
/* Note: We don't account for boundaries here, since we are not going to split any
/* NOTE: We don't account for boundaries here, since we are not going to split any
* curve. */
r_point_side[src_point] = (squared_distance <= this->eraser_squared_radius_pixels) ?
PointCircleSide::Inside :

@ -74,7 +74,7 @@ struct GreasePencilStrokeParams {
const ed::greasepencil::DrawingPlacement &placement;
bke::greasepencil::Drawing &drawing;
/* Note: accessing region in worker threads will return null,
/* NOTE: accessing region in worker threads will return null,
* this has to be done on the main thread and passed explicitly. */
static GreasePencilStrokeParams from_context(const Scene &scene,
Depsgraph &depsgraph,

@ -40,7 +40,7 @@ void CloneOperation::on_stroke_begin(const bContext &C, const InputSample &start
this->init_stroke(C, start_sample);
/* Note: Only one copy is created at the beginning of each stroke.
/* NOTE: Only one copy is created at the beginning of each stroke.
* GPv2 supposedly has 2 modes:
* - Stamp: Clone on stroke start and then transform (the transform part doesn't work)
* - Continuous: Create multiple copies during the stroke (disabled)

@ -580,7 +580,7 @@ void smooth_brush_toggle_on(const bContext *C, Paint *paint, StrokeCache *cache)
Scene *scene = CTX_data_scene(C);
/* Switch to the blur (smooth) brush if possible. */
/* Note: used for both vertexpaint and weightpaint, VPAINT_TOOL_BLUR & WPAINT_TOOL_BLUR are the
/* NOTE: used for both vertexpaint and weightpaint, VPAINT_TOOL_BLUR & WPAINT_TOOL_BLUR are the
* same, see comments for eBrushVertexPaintTool & eBrushWeightPaintTool. */
Brush *smooth_brush = BKE_paint_toolslots_brush_get(paint, WPAINT_TOOL_BLUR);
if (!smooth_brush) {

@ -6268,7 +6268,7 @@ void SCULPT_cube_tip_init(Sculpt * /*sd*/, Object *ob, Brush *brush, float mat[4
zero_m4(mat);
calc_brush_local_mat(0.0, ob, unused, mat);
/* Note: we ignore the radius scaling done inside of calc_brush_local_mat to
/* NOTE: we ignore the radius scaling done inside of calc_brush_local_mat to
* duplicate prior behavior.
*
* TODO: try disabling this and check that all edge cases work properly.

@ -875,7 +875,7 @@ static int sculpt_mesh_filter_modal(bContext *C, wmOperator *op, const wmEvent *
return OPERATOR_RUNNING_MODAL;
}
/* Note: some filter types are continuous, for these we store an
/* NOTE: some filter types are continuous, for these we store an
* event history in RNA for continuous.
* This way the user can tweak the last operator properties
* or repeat the op and get expected results. */

@ -370,7 +370,7 @@ static void generate_geometry(gesture::GestureData &gesture_data)
float depth_point[3];
/* Get origin point for OrientationType::View.
* Note: for projection extrusion we add depth_front here
* NOTE: for projection extrusion we add depth_front here
* instead of in the loop.
*/
if (trim_operation->extrude_mode == ExtrudeMode::Fixed) {

@ -33,7 +33,7 @@ struct NodeClipboardItemIDInfo {
/**
* Library filepath of the referenced ID, together with its name it forms a unique identifier.
*
* Note: Library reference is stored as an absolute path. Since the Node clipboard is runtime
* \note Library reference is stored as an absolute path. Since the Node clipboard is runtime
* data, persistent over new blend-files opening, this should guarantee that identical IDs from
* identical libraries can be matched accordingly, even across several blend-files.
*/

@ -398,7 +398,7 @@ static void view3d_main_region_init(wmWindowManager *wm, ARegion *region)
keymap = WM_keymap_ensure(wm->defaultconf, "Sculpt Curves", SPACE_EMPTY, RGN_TYPE_WINDOW);
WM_event_add_keymap_handler(&region->handlers, keymap);
/* Note: Grease Pencil handlers used to be added using `ED_KEYMAP_GPENCIL` in
/* NOTE: Grease Pencil handlers used to be added using `ED_KEYMAP_GPENCIL` in
* `ed_default_handlers` because it needed to be added to multiple editors (as other editors use
* annotations.). But for OB_GREASE_PENCIL, we only need it to register the keymaps for the
* 3D View. */

@ -224,7 +224,7 @@ static bool find_isomorphism(UvElementMap *dest,
const bool found = ED_uvedit_clipboard_maximum_common_subgraph(
graph_source, graph_dest, solution, &solution_length, r_search_abandoned);
/* Todo: Implement "Best Effort" / "Nearest Match" paste functionality here. */
/* TODO: Implement "Best Effort" / "Nearest Match" paste functionality here. */
if (found) {
BLI_assert(solution_length == dest->island_total_unique_uvs[dest_island_index]);

@ -1159,7 +1159,7 @@ static void uvedit_pack_islands_multi(const Scene *scene,
Object *obedit = objects[ob_index];
BMesh *bm = nullptr;
if (bmesh_override) {
/* Note: obedit is still required for aspect ratio and ID_RECALC_GEOMETRY. */
/* NOTE: obedit is still required for aspect ratio and ID_RECALC_GEOMETRY. */
bm = bmesh_override[ob_index];
}
else {

@ -164,7 +164,7 @@ TEST(lazy_function, GraphWithCycle)
GraphOutputSocket &output_socket = graph.add_output(CPPType::get<int>());
graph.add_link(input_socket, fn_node.input(0));
/* Note: This creates a cycle in the graph. However, it should still be possible to evaluate it,
/* NOTE: This creates a cycle in the graph. However, it should still be possible to evaluate it,
* because there is no actual data dependency in the cycle. */
graph.add_link(fn_node.output(0), fn_node.input(1));
graph.add_link(fn_node.output(1), output_socket);

@ -599,7 +599,7 @@ static void build_concurrent(BuildGpencilModifierData *mmd,
const bool reverse = (mmd->transition != GP_BUILD_TRANSITION_GROW);
/* 1) Determine the longest stroke, to figure out when short strokes should start */
/* Todo: A *really* long stroke here could dwarf everything else, causing bad timings */
/* TODO: A *really* long stroke here could dwarf everything else, causing bad timings */
LISTBASE_FOREACH (bGPDstroke *, gps, &gpf->strokes) {
if (gps->totpoints > max_points) {
max_points = gps->totpoints;

@ -536,7 +536,7 @@ struct ShaderCreateInfo {
Type type;
DualBlend blend;
StringRefNull name;
/* Note: Currently only supported by Metal. */
/* NOTE: Currently only supported by Metal. */
int raster_order_group;
bool operator==(const FragOut &b) const

@ -225,7 +225,7 @@ MTLContext::MTLContext(void *ghost_window, void *ghost_context)
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wobjc-method-access"
/* Enable increased concurrent shader compiler limit.
* Note: Disable warning for missing method when building on older OS's, as compiled code will
* NOTE: Disable warning for missing method when building on older OS's, as compiled code will
* still work correctly when run on a system with the API available. */
if (@available(macOS 13.3, *)) {
[this->device setShouldMaximizeConcurrentCompilation:YES];

@ -438,7 +438,7 @@ void MTLBufferPool::begin_new_safe_list()
safelist_lock_.unlock();
/* Release final reference for previous list.
* Note: Outside of lock as this function itself locks. */
* NOTE: Outside of lock as this function itself locks. */
if (previous_list) {
previous_list->decrement_reference();
}

@ -187,7 +187,7 @@ static bool is_program_word(const char *chr, int *len)
int numchars = 0;
for (const char *c = chr; *c != '\0'; c++) {
char ch = *c;
/* Note: Hash (`#`) is not valid in var names, but is used by Closure macro patterns. */
/* NOTE: Hash (`#`) is not valid in var names, but is used by Closure macro patterns. */
if ((ch >= 'a' && ch <= 'z') || (ch >= 'A' && ch <= 'Z') ||
(numchars > 0 && ch >= '0' && ch <= '9') || ch == '_' || ch == '#')
{
@ -2212,7 +2212,7 @@ uint32_t MSLGeneratorInterface::max_sampler_index_for_stage(ShaderStage /*stage*
uint32_t MSLGeneratorInterface::get_sampler_argument_buffer_bind_index(ShaderStage stage)
{
/* Note: Shader stage must be a singular index. Compound shader masks are not valid for this
/* NOTE: Shader stage must be a singular index. Compound shader masks are not valid for this
* function. */
BLI_assert(stage == ShaderStage::VERTEX || stage == ShaderStage::FRAGMENT ||
stage == ShaderStage::COMPUTE);
@ -2506,7 +2506,7 @@ void MSLGeneratorInterface::generate_msl_textures_input_string(std::stringstream
ShaderStage stage,
bool &is_first_parameter)
{
/* Note: Shader stage must be specified as the singular stage index for which the input
/* NOTE: Shader stage must be specified as the singular stage index for which the input
* is generating. Compound stages are not valid inputs. */
BLI_assert(stage == ShaderStage::VERTEX || stage == ShaderStage::FRAGMENT ||
stage == ShaderStage::COMPUTE);

@ -187,7 +187,7 @@ void gpu::MTLTexture::bake_mip_swizzle_view()
}
}
/* Note: Texture type for cube maps can be overridden as a 2D array. This is done
/* NOTE: Texture type for cube maps can be overridden as a 2D array. This is done
* via modifying this textures type flags. */
MTLTextureType texture_view_texture_type = to_metal_type(type_);

@ -161,7 +161,7 @@ void VKShaderInterface::init(const shader::ShaderCreateInfo &info)
}
/* Determine the descriptor set locations after the inputs have been sorted. */
/* Note: input_tot_len is sometimes more than we need. */
/* NOTE: input_tot_len is sometimes more than we need. */
const uint32_t resources_len = input_tot_len;
/* Initialize the descriptor set layout. */

@ -231,7 +231,7 @@ template<int SrcChannels> static void store_sample(const float *sample, float *d
copy_v4_fl4(dst, sample[0], sample[1], 0.0f, 1.0f);
}
else if constexpr (SrcChannels == 1) {
/* Note: single channel sample is stored as grayscale. */
/* NOTE: single channel sample is stored as grayscale. */
copy_v4_fl4(dst, sample[0], sample[0], sample[0], 1.0f);
}
else {

@ -209,7 +209,7 @@ static std::optional<PreprocessedSampleData> preprocess_sample(StringRefNull iob
return {};
}
/* Note: although Alembic can store knots, we do not read them as the functionality is not
/* NOTE: although Alembic can store knots, we do not read them as the functionality is not
* exposed by the Blender's Curves API yet. */
const Int32ArraySamplePtr per_curve_vertices_count = smp.getCurvesNumVertices();
const P3fArraySamplePtr positions = smp.getPositions();

@ -98,7 +98,7 @@ bool ObjectData::is_visible(HydraSceneDelegate *scene_delegate, const Object *ob
if (deg_mode == DAG_EVAL_VIEWPORT) {
ret &= BKE_object_is_visible_in_viewport(scene_delegate->view3d, object);
}
/* Note: visibility for final render we are taking from depsgraph */
/* NOTE: visibility for final render we are taking from depsgraph */
return ret;
}

@ -108,7 +108,7 @@ const EnumPropertyItem rna_enum_brush_curve_preset_items[] = {
{0, nullptr, 0, nullptr, nullptr},
};
/* Note: we don't actually turn these into a single enum bit-mask property,
/* NOTE: we don't actually turn these into a single enum bit-mask property,
* instead we construct individual boolean properties. */
const EnumPropertyItem rna_enum_brush_automasking_flag_items[] = {
{BRUSH_AUTOMASKING_TOPOLOGY,

@ -2573,7 +2573,7 @@ static void rna_def_modifier_gpencilbuild(BlenderRNA *brna)
RNA_def_property_update(prop, 0, "rna_GpencilModifier_update");
/* Speed factor for GP_BUILD_TIMEMODE_DRAWSPEED. */
/* Todo: Does it work? */
/* TODO: Does it work? */
prop = RNA_def_property(srna, "speed_factor", PROP_FLOAT, PROP_FACTOR);
RNA_def_property_float_sdna(prop, nullptr, "speed_fac");
RNA_def_property_ui_text(prop, "Speed Factor", "Multiply recorded drawing speed by a factor");

@ -10724,7 +10724,7 @@ static void rna_def_modifier_grease_pencil_build(BlenderRNA *brna)
RNA_def_property_update(prop, 0, "rna_Modifier_update");
/* Speed factor for MOD_GREASE_PENCIL_BUILD_TIMEMODE_DRAWSPEED. */
/* Todo: Does it work? */
/* TODO: Does it work? */
prop = RNA_def_property(srna, "speed_factor", PROP_FLOAT, PROP_FACTOR);
RNA_def_property_float_sdna(prop, nullptr, "speed_fac");
RNA_def_property_ui_text(prop, "Speed Factor", "Multiply recorded drawing speed by a factor");

@ -1533,7 +1533,7 @@ struct bNodeSocketStaticTypeInfo {
const char *label;
};
/* Note: Socket and interface subtypes could be defined from a single central list,
/* NOTE: Socket and interface subtypes could be defined from a single central list,
* but makesrna cannot have a dependency on BKE, so this list would have to live in RNA itself,
* with BKE etc. accessing the RNA API to get the subtypes info. */
static const bNodeSocketStaticTypeInfo node_socket_subtypes[] = {
@ -1656,7 +1656,7 @@ static void rna_def_node_socket_subtypes(BlenderRNA *brna)
rna_def_node_socket_virtual(brna, "NodeSocketVirtual");
}
/* Note: interface items are defined outside this file.
/* NOTE: interface items are defined outside this file.
* The subtypes must be defined after the base type, so this function
* is called from the interface rna file to ensure correct order. */
void rna_def_node_socket_interface_subtypes(BlenderRNA *brna)

@ -1149,7 +1149,7 @@ static void rna_def_node_tree_interface_items_api(StructRNA *srna)
0,
"Socket Type",
"Type of socket generated on nodes");
/* Note: itemf callback works for the function parameter, it does not require a data pointer. */
/* NOTE: itemf callback works for the function parameter, it does not require a data pointer. */
RNA_def_property_enum_funcs(
parm, nullptr, nullptr, "rna_NodeTreeInterfaceSocket_socket_type_itemf");
RNA_def_pointer(

@ -1405,7 +1405,7 @@ static void rna_property_override_diff_propptr_validate_diffing(
ptrdiff_ctx.rna_itemname_b = rna_itemname_b;
}
/* Note: This will always assign nullptr to these lib-pointers in case `do_id_lib` is false,
/* NOTE: This will always assign nullptr to these lib-pointers in case `do_id_lib` is false,
* which ensures that they will not affect the result of `ptrdiff_ctx.is_valid_for_diffing` in
* the last check below. */
ID *rna_itemid_a = (do_id_pointer && propptr_a->data) ? static_cast<ID *>(propptr_a->data) :

@ -249,7 +249,7 @@ static void generate_cap(const float3 &point,
}
/* Generate a corner between two segments, with a rounded outer perimeter.
* Note: The perimeter is considered to be to the right hand side of the stroke. The left side
* NOTE: The perimeter is considered to be to the right hand side of the stroke. The left side
* perimeter can be generated by reversing the order of points. */
static void generate_corner(const float3 &pt_a,
const float3 &pt_b,
@ -446,7 +446,7 @@ static bke::CurvesGeometry create_curves_outline(const bke::greasepencil::Drawin
PerimeterData &data = thread_data.local();
const bool is_cyclic_curve = src_cyclic[curve_i];
/* Note: Cyclic curves would better be represented by a cyclic perimeter without end caps, but
/* NOTE: Cyclic curves would better be represented by a cyclic perimeter without end caps, but
* we always generate caps for compatibility with GPv2. Fill materials cannot create holes, so
* a cyclic outline does not work well. */
const bool use_caps = true /*!is_cyclic_curve*/;

@ -445,7 +445,7 @@ class NodeDeclaration {
/* Combined list of socket and panel declarations.
* This determines order of sockets in the UI and panel content. */
Vector<ItemDeclarationPtr> items;
/* Note: inputs and outputs pointers are owned by the items list. */
/* NOTE: inputs and outputs pointers are owned by the items list. */
Vector<SocketDeclaration *> inputs;
Vector<SocketDeclaration *> outputs;
std::unique_ptr<aal::RelationsInNode> anonymous_attribute_relations_;

@ -2711,7 +2711,7 @@ static ImBuf *do_text_effect(const SeqRenderData *context,
ImBuf *ibuf2,
ImBuf *ibuf3)
{
/* Note: text rasterization only fills in part of output image,
/* NOTE: text rasterization only fills in part of output image,
* need to clear it. */
ImBuf *out = prepare_effect_imbufs(context, ibuf1, ibuf2, ibuf3, false);
TextVars *data = static_cast<TextVars *>(seq->effectdata);

@ -953,7 +953,7 @@ static void seq_update_scene_strip_sound(Sequence *seq)
}
/* Set `seq->scene` volume.
* Note: Currently this doesn't work well, when this property is animated. Scene strip volume is
* NOTE: Currently this doesn't work well, when this property is animated. Scene strip volume is
* also controlled by `seq_update_sound_properties()` via `seq->volume` which works if animated.
*
* Ideally, the entire `BKE_scene_update_sound()` will happen from a dependency graph, so