Cleanup: capitalize NOTE tag

This commit is contained in:
Campbell Barton 2021-11-30 09:10:05 +11:00
parent 4e45265dc6
commit 76471dbd5e
24 changed files with 29 additions and 29 deletions

View File

@ -388,7 +388,7 @@ static void clg_ctx_fatal_action(CLogContext *ctx)
static void clg_ctx_backtrace(CLogContext *ctx)
{
/* Note: we avoid writing to 'FILE', for back-trace we make an exception,
/* NOTE: we avoid writing to 'FILE', for back-trace we make an exception,
* if necessary we could have a version of the callback that writes to file
* descriptor all at once. */
ctx->callbacks.backtrace_fn(ctx->output_file);

View File

@ -581,7 +581,7 @@ template<typename T> class device_vector : public device_memory {
* from an already allocated base memory. It is freed automatically when it
* goes out of scope, which should happen before base memory is freed.
*
* Note: some devices require offset and size of the sub_ptr to be properly
* NOTE: some devices require offset and size of the sub_ptr to be properly
* aligned to device->mem_address_alingment(). */
class device_sub_ptr {

View File

@ -31,7 +31,7 @@ struct Node;
struct NodeType;
struct Transform;
/* Note: in the following macros we use "type const &" instead of "const type &"
/* NOTE: in the following macros we use "type const &" instead of "const type &"
* to avoid issues when pasting a pointer type. */
#define NODE_SOCKET_API_BASE_METHODS(type_, name, string_name) \
const SocketType *get_##name##_socket() const \

View File

@ -29,7 +29,7 @@ CCL_NAMESPACE_BEGIN
*
* https://www.solidangle.com/research/egsr2013_spherical_rectangle.pdf
*
* Note: light_p is modified when sample_coord is true.
* NOTE: light_p is modified when sample_coord is true.
*/
ccl_device_inline float rect_light_sample(float3 P,
ccl_private float3 *light_p,

View File

@ -2399,7 +2399,7 @@ void GlossyBsdfNode::simplify_settings(Scene *scene)
ShaderInput *roughness_input = input("Roughness");
if (integrator->get_filter_glossy() == 0.0f) {
/* Fallback to Sharp closure for Roughness close to 0.
* Note: Keep the epsilon in sync with kernel!
* NOTE: Keep the epsilon in sync with kernel!
*/
if (!roughness_input->link && roughness <= 1e-4f) {
VLOG(3) << "Using sharp glossy BSDF.";
@ -2492,7 +2492,7 @@ void GlassBsdfNode::simplify_settings(Scene *scene)
ShaderInput *roughness_input = input("Roughness");
if (integrator->get_filter_glossy() == 0.0f) {
/* Fallback to Sharp closure for Roughness close to 0.
* Note: Keep the epsilon in sync with kernel!
* NOTE: Keep the epsilon in sync with kernel!
*/
if (!roughness_input->link && roughness <= 1e-4f) {
VLOG(3) << "Using sharp glass BSDF.";
@ -2585,7 +2585,7 @@ void RefractionBsdfNode::simplify_settings(Scene *scene)
ShaderInput *roughness_input = input("Roughness");
if (integrator->get_filter_glossy() == 0.0f) {
/* Fallback to Sharp closure for Roughness close to 0.
* Note: Keep the epsilon in sync with kernel!
* NOTE: Keep the epsilon in sync with kernel!
*/
if (!roughness_input->link && roughness <= 1e-4f) {
VLOG(3) << "Using sharp refraction BSDF.";

View File

@ -116,7 +116,7 @@ ccl_device_inline void math_vec3_add_strided(
}
/* Elementary matrix operations.
* Note: TriMatrix refers to a square matrix that is symmetric,
* NOTE: TriMatrix refers to a square matrix that is symmetric,
* and therefore its upper-triangular part isn't stored. */
ccl_device_inline void math_trimatrix_add_diagonal(ccl_global float *A,

View File

@ -370,7 +370,7 @@ ccl_device_inline float4 quat_interpolate(float4 q1, float4 q2, float t)
#if defined(__KERNEL_GPU_RAYTRACING__)
return normalize((1.0f - t) * q1 + t * q2);
#else /* defined(__KERNEL_GPU_RAYTRACING__) */
/* note: this does not ensure rotation around shortest angle, q1 and q2
/* NOTE: this does not ensure rotation around shortest angle, q1 and q2
* are assumed to be matched already in transform_motion_decompose */
float costheta = dot(q1, q2);

View File

@ -55,7 +55,7 @@ class VirtualMemoryAllocator {
/**
* Dynamic memory allocator - allows allocation/deallocation
*
* Note: there are 4 bytes overhead for each allocated yet unused object.
* NOTE: there are 4 bytes overhead for each allocated yet unused object.
*/
template<int N> class MemoryAllocator : public VirtualMemoryAllocator {
private:

View File

@ -714,7 +714,7 @@ bool GHOST_SystemX11::processEvents(bool waitForEvent)
anyProcessed = true;
#ifdef USE_UNITY_WORKAROUND
/* note: processEvent() can't include this code because
/* NOTE: processEvent() can't include this code because
* KeymapNotify event have no valid window information. */
/* the X server generates KeymapNotify event immediately after
@ -1514,7 +1514,7 @@ void GHOST_SystemX11::processEvent(XEvent *xe)
* around tablet surface */
window->GetTabletData().Active = xtablet.mode;
/* Note: This event might be generated with incomplete data-set
/* NOTE: This event might be generated with incomplete data-set
* (don't exactly know why, looks like in some cases, if the value does not change,
* it is not included in subsequent #XDeviceMotionEvent events).
* So we have to check which values this event actually contains!

View File

@ -148,7 +148,7 @@ class GHOST_Wintab {
* \param wtY: Wintab cursor y position.
* \return True if Win32 and Wintab cursor positions match within tolerance.
*
* Note: Only test coordinates on button press, not release. This prevents issues when async
* NOTE: Only test coordinates on button press, not release. This prevents issues when async
* mismatch causes mouse movement to replay and snap back, which is only an issue while drawing.
*/
bool testCoordinates(int sysX, int sysY, int wtX, int wtY);

View File

@ -18,7 +18,7 @@
* \ingroup GHOST
*/
/* Note: Requires OpenXR headers to be included before this one for OpenXR types (XrInstance,
/* NOTE: Requires OpenXR headers to be included before this one for OpenXR types (XrInstance,
* XrSession, etc.). */
#pragma once

View File

@ -53,7 +53,7 @@ class GHOST_XrSession {
void draw(void *draw_customdata);
/** Action functions to be called pre-session start.
* Note: The "destroy" functions can also be called post-session start. */
* NOTE: The "destroy" functions can also be called post-session start. */
bool createActionSet(const GHOST_XrActionSetInfo &info);
void destroyActionSet(const char *action_set_name);
bool createActions(const char *action_set_name, uint32_t count, const GHOST_XrActionInfo *infos);

View File

@ -97,7 +97,7 @@ TEST_F(AssetLibraryServiceTest, get_destroy)
AssetLibraryService::destroy();
AssetLibraryService::destroy();
/* Note: there used to be a test for the opposite here, that after a call to
/* NOTE: there used to be a test for the opposite here, that after a call to
* AssetLibraryService::destroy() the above calls should return freshly allocated objects. This
* cannot be reliably tested by just pointer comparison, though. */
}
@ -113,7 +113,7 @@ TEST_F(AssetLibraryServiceTest, library_pointers)
EXPECT_EQ(curfile_lib, service->get_asset_library_current_file())
<< "Calling twice without destroying in between should return the same instance.";
/* Note: there used to be a test for the opposite here, that after a call to
/* NOTE: there used to be a test for the opposite here, that after a call to
* AssetLibraryService::destroy() the above calls should return freshly allocated objects. This
* cannot be reliably tested by just pointer comparison, though. */
}

View File

@ -1475,7 +1475,7 @@ bool data_transfer_layersmapping_vgroups(ListBase *r_map,
* and even have to support NULL data_src in transfer data code
* (we always create a data_dst, though).
*
* Note: Above comment is outdated, but this function was written when that was true.
* NOTE: Above comment is outdated, but this function was written when that was true.
*/
const ListBase *src_defbase = BKE_object_defgroup_list(ob_src);

View File

@ -99,7 +99,7 @@ static bool find_attribute(const std::string &attributes, const char *search_att
*/
static bool test_onedrive_file_is_placeholder(const char *path)
{
/* Note: Currently only checking for the "com.microsoft.OneDrive.RecallOnOpen" extended file
/* NOTE: Currently only checking for the "com.microsoft.OneDrive.RecallOnOpen" extended file
* attribute. In theory this attribute can also be set on files that aren't located inside a
* OneDrive folder. Maybe additional checks are required? */

View File

@ -283,7 +283,7 @@ void occlusion_eval(OcclusionData data,
bent_normal = N;
}
else {
/* Note: using pow(visibility, 6.0) produces NaN (see T87369). */
/* NOTE: using pow(visibility, 6.0) produces NaN (see T87369). */
float tmp = saturate(pow6(visibility));
bent_normal = normalize(mix(bent_normal, N, tmp));
}
@ -337,7 +337,7 @@ float diffuse_occlusion(
* radius1 : First caps radius (arc length in radians)
* radius2 : Second caps radius (in radians)
* dist : Distance between caps (radians between centers of caps)
* Note: Result is divided by pi to save one multiply.
* NOTE: Result is divided by pi to save one multiply.
*/
float spherical_cap_intersection(float radius1, float radius2, float dist)
{

View File

@ -24,7 +24,7 @@ out vec4 FragColor;
*/
vec3 clip_to_aabb(vec3 color, vec3 minimum, vec3 maximum, vec3 average)
{
/* note: only clips towards aabb center (but fast!) */
/* NOTE: only clips towards aabb center (but fast!) */
vec3 center = 0.5 * (maximum + minimum);
vec3 extents = 0.5 * (maximum - minimum);
vec3 dist = color - center;

View File

@ -11,7 +11,7 @@
layout(location = 0) out vec4 transparentAccum;
layout(location = 1) out vec4 revealageAccum;
/* Note: Blending will be skipped on objectId because output is a non-normalized integer buffer. */
/* NOTE: Blending will be skipped on objectId because output is a non-normalized integer buffer. */
layout(location = 2) out uint objectId;
/* Special function only to be used with calculate_transparent_weight(). */

View File

@ -296,7 +296,7 @@ NOTE the other tuning knobs are now in the shader function inputs!
/* (#B1#) */
float FxaaLuma(vec4 rgba)
{
/* note: sqrt because the sampled colors are in a linear colorspace!
/* NOTE: sqrt because the sampled colors are in a linear colorspace!
* this approximates a perceptual conversion, which is good enough for the
* algorithm */
return sqrt(dot(rgba.rgb, vec3(0.2126, 0.7152, 0.0722)));

View File

@ -179,7 +179,7 @@ uniform mat4 ModelMatrixInverse;
* transpose(ViewMatrixInverse) * transpose(ModelMatrixInverse)
*
* Knowing that the view matrix is orthogonal, the transpose is also the inverse.
* Note: This is only valid because we are only using the mat3 of the ViewMatrixInverse.
* NOTE: This is only valid because we are only using the mat3 of the ViewMatrixInverse.
* ViewMatrix * transpose(ModelMatrixInverse)
*/
#define NormalMatrix transpose(mat3(ModelMatrixInverse))

View File

@ -210,7 +210,7 @@ typedef struct KnifeBVH {
typedef struct KnifeTool_OpData {
ARegion *region; /* Region that knifetool was activated in. */
void *draw_handle; /* For drawing preview loop. */
ViewContext vc; /* Note: _don't_ use 'mval', instead use the one we define below. */
ViewContext vc; /* NOTE: _don't_ use 'mval', instead use the one we define below. */
float mval[2]; /* Mouse value with snapping applied. */
Scene *scene;

View File

@ -13,7 +13,7 @@ uniform float dash_factor; /* if > 1.0, solid line. */
/* More advanced mode, allowing for complex, multi-colored patterns.
* Enabled when colors_len > 0. */
/* Note: max number of steps/colors in pattern is 32! */
/* NOTE: max number of steps/colors in pattern is 32! */
uniform int colors_len; /* Enabled if > 0, 1 for solid line. */
uniform vec4 colors[32];

View File

@ -438,7 +438,7 @@ void SEQ_image_transform_mirror_factor_get(const Sequence *seq, float r_mirror[2
/**
* Get strip transform origin offset from image center
* Note: This function does not apply axis mirror.
* NOTE: This function does not apply axis mirror.
*
* \param scene: Scene in which strips are located
* \param seq: Sequence to calculate image transform origin

View File

@ -553,7 +553,7 @@ static int wm_xr_navigation_grab_modal(bContext *C, wmOperator *op, const wmEven
wm_xr_navigation_grab_bimanual_state_update(actiondata, data);
/* Note: KM_PRESS and KM_RELEASE are the only two values supported by XR events during event
/* NOTE: #KM_PRESS and #KM_RELEASE are the only two values supported by XR events during event
* dispatching (see #wm_xr_session_action_states_interpret()). For modal XR operators, modal
* handling starts when an input is "pressed" (action state exceeds the action threshold) and
* ends when the input is "released" (state falls below the threshold). */