Cleanup: doxy param syntax

This commit is contained in:
Campbell Barton 2020-11-04 00:01:00 +11:00
parent f278d814fd
commit 7ceb622fd3
3 changed files with 12 additions and 12 deletions

View File

@ -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

View File

@ -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. */

View File

@ -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],