[Bf-blender-cvs] [7ceb622fd3d] master: Cleanup: doxy param syntax

Campbell Barton noreply at git.blender.org
Tue Nov 3 14:05:01 CET 2020


Commit: 7ceb622fd3d8629226ef1c0ca028aa89194f5131
Author: Campbell Barton
Date:   Wed Nov 4 00:01:00 2020 +1100
Branches: master
https://developer.blender.org/rB7ceb622fd3d8629226ef1c0ca028aa89194f5131

Cleanup: doxy param syntax

===================================================================

M	source/blender/blenkernel/intern/customdata.c
M	source/blender/blenlib/intern/storage_apple.mm
M	source/blender/imbuf/intern/rectop.c

===================================================================

diff --git a/source/blender/blenkernel/intern/customdata.c b/source/blender/blenkernel/intern/customdata.c
index d762b1b0604..0ad09b2f664 100644
--- a/source/blender/blenkernel/intern/customdata.c
+++ b/source/blender/blenkernel/intern/customdata.c
@@ -2997,7 +2997,7 @@ void CustomData_free_elem(CustomData *data, int index, int count)
 /**
  * Interpolate given custom data source items into a single destination one.
  *
- * \param src_indices Indices of every source items to interpolate into the destination one.
+ * \param src_indices: Indices of every source items to interpolate into the destination one.
  * \param weights: The weight to apply to each source value individually. If NULL, they will be
  * averaged.
  * \param sub_weights: The weights of sub-items, only used to affect each corners of a
diff --git a/source/blender/blenlib/intern/storage_apple.mm b/source/blender/blenlib/intern/storage_apple.mm
index 564ef5a199a..2a4bbffa60e 100644
--- a/source/blender/blenlib/intern/storage_apple.mm
+++ b/source/blender/blenlib/intern/storage_apple.mm
@@ -29,7 +29,7 @@
 #include "BLI_path_util.h"
 
 /**
- * \param r_targetpath Buffer for the target path an alias points to.
+ * \param r_targetpath: Buffer for the target path an alias points to.
  * \return Whether the file at the input path is an alias.
  */
 /* False alarm by clang-tidy: #getFileSystemRepresentation changes the return value argument. */
diff --git a/source/blender/imbuf/intern/rectop.c b/source/blender/imbuf/intern/rectop.c
index 8e348ead756..cdc8cd1068c 100644
--- a/source/blender/imbuf/intern/rectop.c
+++ b/source/blender/imbuf/intern/rectop.c
@@ -1071,8 +1071,8 @@ void IMB_rectblend_threaded(ImBuf *dbuf,
 
 /**
  * Replace pixels of entire image with solid color.
- * \param ibuf an image to be filled with color. It must be 4 channel image.
- * \param col RGBA color, which is assigned directly to both byte (via scaling) and float buffers.
+ * \param ibuf: An image to be filled with color. It must be 4 channel image.
+ * \param col: RGBA color, which is assigned directly to both byte (via scaling) and float buffers.
  */
 void IMB_rectfill(ImBuf *drect, const float col[4])
 {
@@ -1108,9 +1108,9 @@ void IMB_rectfill(ImBuf *drect, const float col[4])
 
 /**
  * Replace pixels of image area with solid color.
- * \param ibuf an image to be filled with color. It must be 4 channel image.
- * \param col RGBA color, which is assigned directly to both byte (via scaling) and float buffers.
- * \param x1, y1, x2, y2 (x1, y1) defines starting point of the rectangular area to be filled,
+ * \param ibuf: an image to be filled with color. It must be 4 channel image.
+ * \param col: RGBA color, which is assigned directly to both byte (via scaling) and float buffers.
+ * \param x1, y1, x2, y2: (x1, y1) defines starting point of the rectangular area to be filled,
  * (x2, y2) is the end point. Note that values are allowed to be loosely ordered, which means that
  * x2 is allowed to be lower than x1, as well as y2 is allowed to be lower than y1. No matter the
  * order the area between x1 and x2, and y1 and y2 is filled.
@@ -1275,17 +1275,17 @@ void buf_rectfill_area(unsigned char *rect,
 /**
  * Blend pixels of image area with solid color.
  *
- * For images with uchar buffer use color matching image colorspace.
+ * For images with `uchar` buffer use color matching image colorspace.
  * For images with float buffer use color display colorspace.
  * If display colorspace can not be referenced, use color in SRGB colorspace.
  *
- * \param ibuf an image to be filled with color. It must be 4 channel image.
- * \param col RGBA color.
- * \param x1, y1, x2, y2 (x1, y1) defines starting point of the rectangular area to be filled,
+ * \param ibuf: an image to be filled with color. It must be 4 channel image.
+ * \param col: RGBA color.
+ * \param x1, y1, x2, y2: (x1, y1) defines starting point of the rectangular area to be filled,
  * (x2, y2) is the end point. Note that values are allowed to be loosely ordered, which means that
  * x2 is allowed to be lower than x1, as well as y2 is allowed to be lower than y1. No matter the
  * order the area between x1 and x2, and y1 and y2 is filled.
- * \param display colorspace reference for display space.
+ * \param display: colorspace reference for display space.
  */
 void IMB_rectfill_area(ImBuf *ibuf,
                        const float col[4],



More information about the Bf-blender-cvs mailing list