[Bf-blender-cvs] [59ce3b8f6b1] master: Cleanup: doxygen comment use
Campbell Barton
noreply at git.blender.org
Mon Jan 9 08:57:24 CET 2023
Commit: 59ce3b8f6b1cec9ed76929e56093ac2813fb6aed
Author: Campbell Barton
Date: Mon Jan 9 18:56:17 2023 +1100
Branches: master
https://developer.blender.org/rB59ce3b8f6b1cec9ed76929e56093ac2813fb6aed
Cleanup: doxygen comment use
Avoid '\note' outside of doxygen comments.
===================================================================
M source/blender/blenkernel/BKE_lib_override.h
M source/blender/blenlib/BLI_math_matrix.hh
M source/blender/draw/intern/draw_cache_impl_pointcloud.cc
M source/blender/draw/intern/draw_curves.cc
M source/blender/draw/intern/draw_hair.cc
M source/blender/draw/intern/shaders/common_pointcloud_lib.glsl
M source/blender/draw/intern/shaders/draw_command_generate_comp.glsl
M source/blender/geometry/intern/trim_curves.cc
M source/blender/geometry/intern/uv_parametrizer.cc
M source/blender/gpu/shaders/common/gpu_shader_math_matrix_lib.glsl
===================================================================
diff --git a/source/blender/blenkernel/BKE_lib_override.h b/source/blender/blenkernel/BKE_lib_override.h
index 4928ffda0ec..12139b7a6f0 100644
--- a/source/blender/blenkernel/BKE_lib_override.h
+++ b/source/blender/blenkernel/BKE_lib_override.h
@@ -401,7 +401,7 @@ bool BKE_lib_override_library_status_check_reference(struct Main *bmain, struct
* Compare local and reference data-blocks and create new override operations as needed,
* or reset to reference values if overriding is not allowed.
*
- * \param r_report_flags #eRNAOverrideMatchResult flags giving info about the result of this call.
+ * \param r_report_flags: #eRNAOverrideMatchResult flags giving info about the result of this call.
*
* \note Defining override operations is only mandatory before saving a `.blend` file on disk
* (not for undo!).
@@ -417,7 +417,7 @@ void BKE_lib_override_library_operations_create(struct Main *bmain,
/**
* Check all overrides from given \a bmain and create/update overriding operations as needed.
*
- * \param r_report_flags #eRNAOverrideMatchResult flags giving info about the result of this call.
+ * \param r_report_flags: #eRNAOverrideMatchResult flags giving info about the result of this call.
*/
void BKE_lib_override_library_main_operations_create(struct Main *bmain,
bool force_auto,
@@ -427,7 +427,7 @@ void BKE_lib_override_library_main_operations_create(struct Main *bmain,
* Restore forbidden modified override properties to the values of their matching properties in the
* linked reference ID.
*
- * \param r_report_flags #eRNAOverrideMatchResult flags giving info about the result of this call.
+ * \param r_report_flags: #eRNAOverrideMatchResult flags giving info about the result of this call.
*
* \note Typically used as part of BKE_lib_override_library_main_operations_create process, since
* modifying RNA properties from non-main threads is not safe.
@@ -439,7 +439,7 @@ void BKE_lib_override_library_operations_restore(struct Main *bmain,
* Restore forbidden modified override properties to the values of their matching properties in the
* linked reference ID, for all liboverride IDs tagged as needing such process in given `bmain`.
*
- * \param r_report_flags #eRNAOverrideMatchResult flags giving info about the result of this call.
+ * \param r_report_flags: #eRNAOverrideMatchResult flags giving info about the result of this call.
*
* \note Typically used as part of BKE_lib_override_library_main_operations_create process, since
* modifying RNA properties from non-main threads is not safe.
diff --git a/source/blender/blenlib/BLI_math_matrix.hh b/source/blender/blenlib/BLI_math_matrix.hh
index 219e41314f5..79699e082f6 100644
--- a/source/blender/blenlib/BLI_math_matrix.hh
+++ b/source/blender/blenlib/BLI_math_matrix.hh
@@ -254,7 +254,7 @@ template<typename T, bool Normalized = false>
/**
* Extract the absolute 3d scale from a transform matrix.
- * \tparam AllowNegativeScale if true, will compute determinant to know if matrix is negative.
+ * \tparam AllowNegativeScale: if true, will compute determinant to know if matrix is negative.
* This is a costly operation so it is disabled by default.
*/
template<bool AllowNegativeScale = false, typename T, int NumCol, int NumRow>
@@ -262,7 +262,7 @@ template<bool AllowNegativeScale = false, typename T, int NumCol, int NumRow>
/**
* Decompose a matrix into location, rotation, and scale components.
- * \tparam AllowNegativeScale if true, will compute determinant to know if matrix is negative.
+ * \tparam AllowNegativeScale: if true, will compute determinant to know if matrix is negative.
* Rotation and scale values will be flipped if it is negative.
* This is a costly operation so it is disabled by default.
*/
diff --git a/source/blender/draw/intern/draw_cache_impl_pointcloud.cc b/source/blender/draw/intern/draw_cache_impl_pointcloud.cc
index ddbfe232361..4997aef6089 100644
--- a/source/blender/draw/intern/draw_cache_impl_pointcloud.cc
+++ b/source/blender/draw/intern/draw_cache_impl_pointcloud.cc
@@ -225,7 +225,7 @@ static const uint half_octahedron_tris[4][3] = {
static void pointcloud_extract_indices(const PointCloud &pointcloud, PointCloudBatchCache &cache)
{
- /** \note: Avoid modulo by non-power-of-two in shader. */
+ /** \note Avoid modulo by non-power-of-two in shader. */
uint32_t vertid_max = pointcloud.totpoint * 32;
uint32_t index_len = pointcloud.totpoint * ARRAY_SIZE(half_octahedron_tris);
diff --git a/source/blender/draw/intern/draw_curves.cc b/source/blender/draw/intern/draw_curves.cc
index 3660b460e25..62493df95f9 100644
--- a/source/blender/draw/intern/draw_curves.cc
+++ b/source/blender/draw/intern/draw_curves.cc
@@ -395,7 +395,7 @@ DRWShadingGroup *DRW_shgroup_curves_create_sub(Object *object,
DRW_shgroup_uniform_float_copy(shgrp, "hairRadTip", hair_rad_tip);
DRW_shgroup_uniform_bool_copy(shgrp, "hairCloseTip", hair_close_tip);
if (gpu_material) {
- /* \note: This needs to happen before the drawcall to allow correct attribute extraction.
+ /* NOTE: This needs to happen before the drawcall to allow correct attribute extraction.
* (see T101896) */
DRW_shgroup_add_material_resources(shgrp, gpu_material);
}
diff --git a/source/blender/draw/intern/draw_hair.cc b/source/blender/draw/intern/draw_hair.cc
index 9e1969d2f68..a7632abeafc 100644
--- a/source/blender/draw/intern/draw_hair.cc
+++ b/source/blender/draw/intern/draw_hair.cc
@@ -294,7 +294,7 @@ DRWShadingGroup *DRW_shgroup_hair_create_sub(Object *object,
DRW_shgroup_uniform_float_copy(shgrp, "hairRadTip", hair_rad_tip);
DRW_shgroup_uniform_bool_copy(shgrp, "hairCloseTip", hair_close_tip);
if (gpu_material) {
- /* \note: This needs to happen before the drawcall to allow correct attribute extraction.
+ /* NOTE: This needs to happen before the drawcall to allow correct attribute extraction.
* (see T101896) */
DRW_shgroup_add_material_resources(shgrp, gpu_material);
}
diff --git a/source/blender/draw/intern/shaders/common_pointcloud_lib.glsl b/source/blender/draw/intern/shaders/common_pointcloud_lib.glsl
index 018e62b8c65..9d2a6f37882 100644
--- a/source/blender/draw/intern/shaders/common_pointcloud_lib.glsl
+++ b/source/blender/draw/intern/shaders/common_pointcloud_lib.glsl
@@ -53,7 +53,7 @@ void pointcloud_get_pos_nor_radius(out vec3 outpos, out vec3 outnor, out float o
mat3 facing_mat = pointcloud_get_facing_matrix(p);
- /** \note: Avoid modulo by non-power-of-two in shader. See Index buffer setup. */
+ /* NOTE: Avoid modulo by non-power-of-two in shader. See Index buffer setup. */
int vert_id = gl_VertexID % 32;
vec3 pos_inst = vec3(0.0);
diff --git a/source/blender/draw/intern/shaders/draw_command_generate_comp.glsl b/source/blender/draw/intern/shaders/draw_command_generate_comp.glsl
index ddb4baf8f5b..75e5cda29d2 100644
--- a/source/blender/draw/intern/shaders/draw_command_generate_comp.glsl
+++ b/source/blender/draw/intern/shaders/draw_command_generate_comp.glsl
@@ -51,7 +51,7 @@ void main()
if (visibility_word_per_draw > 0) {
uint visibility_word = resource_index * visibility_word_per_draw;
for (uint i = 0; i < visibility_word_per_draw; i++, visibility_word++) {
- /* \note: This assumes proto.instance_len is 1. */
+ /* NOTE: This assumes `proto.instance_len` is 1. */
/* TODO: Assert. */
visible_instance_len += bitCount(visibility_buf[visibility_word]);
}
diff --git a/source/blender/geometry/intern/trim_curves.cc b/source/blender/geometry/intern/trim_curves.cc
index 53a22b581b5..94bd212d70e 100644
--- a/source/blender/geometry/intern/trim_curves.cc
+++ b/source/blender/geometry/intern/trim_curves.cc
@@ -295,7 +295,7 @@ static bke::curves::bezier::Insertion knot_insert_bezier(
* Sample source curve data in the interval defined by the points [start_point, end_point].
* Uses linear interpolation to compute the endpoints.
*
- * \tparam include_start_point If False, the 'start_point' point sample will not be copied
+ * \tparam include_start_point: If False, the 'start_point' point sample will not be copied
* and not accounted for in the destination range.
* \param src_data: Source to sample from.
* \param dst_data: Destination to write samples to.
diff --git a/source/blender/geometry/intern/uv_parametrizer.cc b/source/blender/geometry/intern/uv_parametrizer.cc
index ed8c4b46e50..ff3458aa0e6 100644
--- a/source/blender/geometry/intern/uv_parametrizer.cc
+++ b/source/blender/geometry/intern/uv_parametrizer.cc
@@ -3897,9 +3897,10 @@ void GEO_uv_parametrizer_face_add(ParamHandle *phandle,
continue;
}
- /* An existing triangle has already been inserted. As a heuristic, attempt to add the
- * *previous* triangle. \note: Should probably call `GEO_uv_parametrizer_face_add` instead of
- * `p_face_add_construct`. */
+ /* An existing triangle has already been inserted.
+ * As a heuristic, attempt to add the *previous* triangle.
+ * NOTE: Should probably call `GEO_uv_parametrizer_face_add`
+ * instead of `p_face_add_construct`. */
int iprev = permute[(i + pm - 1) % pm];
p_face_add_construct(phandle, key, vkeys, co, uv, iprev, i0, i1, pin, select);
diff --git a/source/blender/gpu/shaders/common/gpu_shader_math_matrix_lib.glsl b/source/blender/gpu/shaders/common/gpu_shader_math_matrix_lib.glsl
index 0363a64d5c5..ded6904451f 100644
--- a/source/blender/gpu/shaders/common/gpu_shader_math_matrix_lib.glsl
+++ b/source/blender/gpu/shaders/common/gpu_shader_math_matrix_lib.glsl
@@ -277,7 +277,7 @@ vec3 to_scale(mat4x4 mat, const bool allow_negative_scale);
/**
* Decompose a matrix into location, rotation, and scale components.
- * \tparam allow_negative_scale if true, will compute determinant to know if matrix is negative.
+ * \tparam allow_negative_scale: if true, will compute determinant to know if matrix is negative.
* Rotation and scale values will be flipped if it is negative.
* This is a costly operation so it is disabled by default.
*/
@@ -907,7 +907,7 @@ mat3x3 from_rotation(EulerXYZ rotation)
mat3x3 from_rotation(Quaternion
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list