Cleanup: use of doxygen params in doc-strings

This commit is contained in:
Campbell Barton
2025-09-14 15:14:55 +10:00
parent ab43c57a2a
commit e6c0a204f6
7 changed files with 23 additions and 18 deletions

View File

@@ -5537,8 +5537,8 @@ static void con_unlink_refs_cb(bConstraint * /*con*/,
/**
* Helper function to invoke the id_looper callback, including custom space.
*
* \param flag is unused right now, but it's kept as a reminder that new code may need to check
* flags as well. See enum LibraryForeachIDFlag in BKE_lib_query.hh.
* \param flag: is unused right now, but it's kept as a reminder that new code may need to check
* flags as well. See enum #LibraryForeachIDFlag in `BKE_lib_query.hh`.
*/
static void con_invoke_id_looper(const bConstraintTypeInfo *cti,
bConstraint *con,

View File

@@ -346,10 +346,10 @@ bool BLI_file_touch(const char *filepath)
*
* If the directory already exists, this function is a no-op.
*
* \param dirname The directory to create.
* \param len The number of bytes of 'dirname' to use as path to create. This
* makes the recursive call possible without doing string duplication for each
* parent directory.
* \param dirname: The directory to create.
* \param len: The number of bytes of `dirname` to use as path to create.
* This makes the recursive call possible without doing string duplication
* for each parent directory.
*/
static bool dir_create_recursive(const char *dirname, const int len)
{

View File

@@ -19,9 +19,10 @@ struct PointerRNA;
bool ED_outliner_collections_editor_poll(bContext *C);
/**
* Populates the \param objects: ListBase with all the outliner selected objects
* We store it as (Object *)LinkData->data
* \param objects: expected to be empty
* Populates the `objects` #ListBase with all the outliner selected objects
* We store it as `(Object *)LinkData->data`.
*
* \param objects: Expected to be empty.
*/
void ED_outliner_selected_objects_get(const bContext *C, ListBase *objects);

View File

@@ -23,9 +23,9 @@ void ED_time_scrub_draw_current_frame(const ARegion *region,
bool display_stalk = true);
/**
* Draw the scrub area with numbers inside.
* \param display_seconds defines if the display is in seconds or in frames.
* \param base defines the base number from which the number distance is calculated. The distance
* is always a simple fraction or a multiple of that number.
* \param display_seconds: Defines if the display is in seconds or in frames.
* \param base: Defines the base number from which the number distance is calculated.
* The distance is always a simple fraction or a multiple of that number.
*/
void ED_time_scrub_draw(const ARegion *region,
const Scene *scene,

View File

@@ -219,8 +219,10 @@ void UI_view2d_dot_grid_draw(const View2D *v2d,
int grid_subdivisions);
/**
* Draw horizontal lines. The \param base defines in what step the lines are drawn. Depending on
* the zoom level of the `v2d` the step is a full fraction of the given base.
* Draw horizontal lines.
*
* \param base: Defines in what step the lines are drawn.
* Depending on the zoom level of the `v2d` the step is a full fraction of the given base.
*/
void UI_view2d_draw_lines_y__values(const View2D *v2d, int base);
void UI_view2d_draw_lines_x__values(const View2D *v2d, int base);

View File

@@ -76,9 +76,11 @@ static int get_divisor(const int distance)
}
/**
* Calculates the distance in frames between major lines. The lowest value it can return is 1.
* The \param base defines how the step is calculated. The returned step is either a full fraction
* or a multiple of that number.
* Calculates the distance in frames between major lines.
* The lowest value it can return is 1.
*
* \param base: Defines how the step is calculated.
* The returned step is either a full fraction or a multiple of that number.
*/
static int calculate_grid_step(const int base, const float pixel_width, const float view_width)
{

View File

@@ -28,9 +28,9 @@ blender::gpu::UniformBuf *GPU_uniformbuf_create_ex(size_t size,
const char *name);
/**
* Create UBO from inputs list.
* Return nullptr if failed to create or if \param inputs: is empty.
*
* \param inputs: ListBase of #BLI_genericNodeN(#GPUInput).
* \return nullptr if failed to create or if `inputs` is empty.
*/
blender::gpu::UniformBuf *GPU_uniformbuf_create_from_list(ListBase *inputs, const char *name);