Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2018-12-12 04:50:58 +0300
committerCampbell Barton <ideasman42@gmail.com>2018-12-12 04:50:58 +0300
commite757c4a3bec8b0e8d198531a28327332af00a9ba (patch)
tree4707fd51cffdbe932123a29bbcfe4528fc9c2b55 /source/blender/blenlib
parentba8d6ca3dd92eed5d679caa28f5446cd07b8a112 (diff)
Cleanup: use colon separator after parameter
Helps separate variable names from descriptive text. Was already used in some parts of the code, double space and dashes were used elsewhere.
Diffstat (limited to 'source/blender/blenlib')
-rw-r--r--source/blender/blenlib/BLI_astar.h8
-rw-r--r--source/blender/blenlib/PIL_time.h2
-rw-r--r--source/blender/blenlib/intern/BLI_dynstr.c22
-rw-r--r--source/blender/blenlib/intern/BLI_ghash.c52
-rw-r--r--source/blender/blenlib/intern/BLI_kdtree.c2
-rw-r--r--source/blender/blenlib/intern/BLI_mempool.c14
-rw-r--r--source/blender/blenlib/intern/astar.c12
-rw-r--r--source/blender/blenlib/intern/convexhull_2d.c16
-rw-r--r--source/blender/blenlib/intern/edgehash.c6
-rw-r--r--source/blender/blenlib/intern/fileops.c10
-rw-r--r--source/blender/blenlib/intern/freetypefont.c2
-rw-r--r--source/blender/blenlib/intern/gsqueue.c6
-rw-r--r--source/blender/blenlib/intern/listbase.c4
-rw-r--r--source/blender/blenlib/intern/math_base_inline.c6
-rw-r--r--source/blender/blenlib/intern/math_geom.c22
-rw-r--r--source/blender/blenlib/intern/math_geom_inline.c4
-rw-r--r--source/blender/blenlib/intern/math_rotation.c6
-rw-r--r--source/blender/blenlib/intern/math_solvers.c8
-rw-r--r--source/blender/blenlib/intern/math_statistics.c14
-rw-r--r--source/blender/blenlib/intern/path_util.c20
-rw-r--r--source/blender/blenlib/intern/string.c92
-rw-r--r--source/blender/blenlib/intern/string_utf8.c12
-rw-r--r--source/blender/blenlib/intern/string_utils.c38
-rw-r--r--source/blender/blenlib/intern/task.c8
-rw-r--r--source/blender/blenlib/intern/timecode.c20
25 files changed, 203 insertions, 203 deletions
diff --git a/source/blender/blenlib/BLI_astar.h b/source/blender/blenlib/BLI_astar.h
index 5e9434a1d56..99e0dcd1a27 100644
--- a/source/blender/blenlib/BLI_astar.h
+++ b/source/blender/blenlib/BLI_astar.h
@@ -90,10 +90,10 @@ void BLI_astar_solution_free(BLI_AStarSolution *as_solution);
* Callback computing the current cost (distance) to next node, and the estimated overall cost to destination node
* (A* expects this estimation to always be less or equal than actual shortest path from next node to destination one).
*
- * \param link the graph link between current node and next one.
- * \param node_idx_curr current node index.
- * \param node_idx_next next node index.
- * \param node_idx_dst destination node index.
+ * \param link: the graph link between current node and next one.
+ * \param node_idx_curr: current node index.
+ * \param node_idx_next: next node index.
+ * \param node_idx_dst: destination node index.
*/
typedef float (*astar_f_cost)(BLI_AStarGraph *as_graph, BLI_AStarSolution *as_solution, BLI_AStarGNLink *link,
const int node_idx_curr, const int node_idx_next, const int node_idx_dst);
diff --git a/source/blender/blenlib/PIL_time.h b/source/blender/blenlib/PIL_time.h
index 088b275738e..077e48772e5 100644
--- a/source/blender/blenlib/PIL_time.h
+++ b/source/blender/blenlib/PIL_time.h
@@ -53,7 +53,7 @@ long int PIL_check_seconds_timer_i(void);
/**
* Platform-independent sleep function.
- * \param ms Number of milliseconds to sleep
+ * \param ms: Number of milliseconds to sleep
*/
void PIL_sleep_ms(int ms);
diff --git a/source/blender/blenlib/intern/BLI_dynstr.c b/source/blender/blenlib/intern/BLI_dynstr.c
index d3fc8ae0ed5..c1f9906cc12 100644
--- a/source/blender/blenlib/intern/BLI_dynstr.c
+++ b/source/blender/blenlib/intern/BLI_dynstr.c
@@ -108,8 +108,8 @@ BLI_INLINE void *dynstr_alloc(DynStr *__restrict ds, size_t size)
/**
* Append a c-string to a DynStr.
*
- * \param ds The DynStr to append to.
- * \param cstr The c-string to append.
+ * \param ds: The DynStr to append to.
+ * \param cstr: The c-string to append.
*/
void BLI_dynstr_append(DynStr *__restrict ds, const char *cstr)
{
@@ -131,9 +131,9 @@ void BLI_dynstr_append(DynStr *__restrict ds, const char *cstr)
/**
* Append a length clamped c-string to a DynStr.
*
- * \param ds The DynStr to append to.
- * \param cstr The c-string to append.
- * \param len The maximum length of the c-string to copy.
+ * \param ds: The DynStr to append to.
+ * \param cstr: The c-string to append.
+ * \param len: The maximum length of the c-string to copy.
*/
void BLI_dynstr_nappend(DynStr *__restrict ds, const char *cstr, int len)
{
@@ -209,8 +209,8 @@ void BLI_dynstr_vappendf(DynStr *__restrict ds, const char *__restrict format, v
/**
* Append a c-string to a DynStr, but with formatting like printf.
*
- * \param ds The DynStr to append to.
- * \param format The printf format string to use.
+ * \param ds: The DynStr to append to.
+ * \param format: The printf format string to use.
*/
void BLI_dynstr_appendf(DynStr *__restrict ds, const char *__restrict format, ...)
{
@@ -271,7 +271,7 @@ void BLI_dynstr_appendf(DynStr *__restrict ds, const char *__restrict format, ..
/**
* Find the length of a DynStr.
*
- * \param ds The DynStr of interest.
+ * \param ds: The DynStr of interest.
* \return The length of \a ds.
*/
int BLI_dynstr_get_len(DynStr *ds)
@@ -308,7 +308,7 @@ void BLI_dynstr_get_cstring_ex(DynStr *__restrict ds, char *__restrict rets)
* <i> The returned c-string should be freed
* using MEM_freeN. </i>
*
- * \param ds The DynStr of interest.
+ * \param ds: The DynStr of interest.
* \return The contents of \a ds as a c-string.
*/
char *BLI_dynstr_get_cstring(DynStr *ds)
@@ -321,7 +321,7 @@ char *BLI_dynstr_get_cstring(DynStr *ds)
/**
* Clear the DynStr
*
- * \param ds The DynStr to clear.
+ * \param ds: The DynStr to clear.
*/
void BLI_dynstr_clear(DynStr *ds)
{
@@ -344,7 +344,7 @@ void BLI_dynstr_clear(DynStr *ds)
/**
* Free the DynStr
*
- * \param ds The DynStr to free.
+ * \param ds: The DynStr to free.
*/
void BLI_dynstr_free(DynStr *ds)
{
diff --git a/source/blender/blenlib/intern/BLI_ghash.c b/source/blender/blenlib/intern/BLI_ghash.c
index ec75c140159..edc6286118d 100644
--- a/source/blender/blenlib/intern/BLI_ghash.c
+++ b/source/blender/blenlib/intern/BLI_ghash.c
@@ -700,10 +700,10 @@ static GHash *ghash_copy(GHash *gh, GHashKeyCopyFP keycopyfp, GHashValCopyFP val
/**
* Creates a new, empty GHash.
*
- * \param hashfp Hash callback.
- * \param cmpfp Comparison callback.
- * \param info Identifier string for the GHash.
- * \param nentries_reserve Optionally reserve the number of members that the hash will hold.
+ * \param hashfp: Hash callback.
+ * \param cmpfp: Comparison callback.
+ * \param info: Identifier string for the GHash.
+ * \param nentries_reserve: Optionally reserve the number of members that the hash will hold.
* Use this to avoid resizing buckets if the size is known or can be closely approximated.
* \return An empty GHash.
*/
@@ -796,7 +796,7 @@ void *BLI_ghash_replace_key(GHash *gh, void *key)
/**
* Lookup the value of \a key in \a gh.
*
- * \param key The key to lookup.
+ * \param key: The key to lookup.
* \returns the value for \a key or NULL.
*
* \note When NULL is a valid value, use #BLI_ghash_lookup_p to differentiate a missing key
@@ -822,7 +822,7 @@ void *BLI_ghash_lookup_default(GHash *gh, const void *key, void *val_default)
/**
* Lookup a pointer to the value of \a key in \a gh.
*
- * \param key The key to lookup.
+ * \param key: The key to lookup.
* \returns the pointer to value for \a key or NULL.
*
* \note This has 2 main benefits over #BLI_ghash_lookup.
@@ -895,9 +895,9 @@ bool BLI_ghash_ensure_p_ex(
/**
* Remove \a key from \a gh, or return false if the key wasn't found.
*
- * \param key The key to remove.
- * \param keyfreefp Optional callback to free the key.
- * \param valfreefp Optional callback to free the value.
+ * \param key: The key to remove.
+ * \param keyfreefp: Optional callback to free the key.
+ * \param valfreefp: Optional callback to free the value.
* \return true if \a key was removed from \a gh.
*/
bool BLI_ghash_remove(GHash *gh, const void *key, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp)
@@ -919,8 +919,8 @@ bool BLI_ghash_remove(GHash *gh, const void *key, GHashKeyFreeFP keyfreefp, GHas
/**
* Remove \a key from \a gh, returning the value or NULL if the key wasn't found.
*
- * \param key The key to remove.
- * \param keyfreefp Optional callback to free the key.
+ * \param key: The key to remove.
+ * \param keyfreefp: Optional callback to free the key.
* \return the value of \a key int \a gh or NULL.
*/
void *BLI_ghash_popkey(GHash *gh, const void *key, GHashKeyFreeFP keyfreefp)
@@ -979,9 +979,9 @@ bool BLI_ghash_pop(
/**
* Reset \a gh clearing all entries.
*
- * \param keyfreefp Optional callback to free the key.
- * \param valfreefp Optional callback to free the value.
- * \param nentries_reserve Optionally reserve the number of members that the hash will hold.
+ * \param keyfreefp: Optional callback to free the key.
+ * \param valfreefp: Optional callback to free the value.
+ * \param nentries_reserve: Optionally reserve the number of members that the hash will hold.
*/
void BLI_ghash_clear_ex(
GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp,
@@ -1005,9 +1005,9 @@ void BLI_ghash_clear(GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfree
/**
* Frees the GHash and its members.
*
- * \param gh The GHash to free.
- * \param keyfreefp Optional callback to free the key.
- * \param valfreefp Optional callback to free the value.
+ * \param gh: The GHash to free.
+ * \param keyfreefp: Optional callback to free the key.
+ * \param valfreefp: Optional callback to free the value.
*/
void BLI_ghash_free(GHash *gh, GHashKeyFreeFP keyfreefp, GHashValFreeFP valfreefp)
{
@@ -1047,7 +1047,7 @@ void BLI_ghash_flag_clear(GHash *gh, uint flag)
* while the iterator is in use, and the iterator will step exactly
* BLI_ghash_len(gh) times before becoming done.
*
- * \param gh The GHash to iterate over.
+ * \param gh: The GHash to iterate over.
* \return Pointer to a new DynStr.
*/
GHashIterator *BLI_ghashIterator_new(GHash *gh)
@@ -1062,8 +1062,8 @@ GHashIterator *BLI_ghashIterator_new(GHash *gh)
* be mutated while the iterator is in use, and the iterator will
* step exactly BLI_ghash_len(gh) times before becoming done.
*
- * \param ghi The GHashIterator to initialize.
- * \param gh The GHash to iterate over.
+ * \param ghi: The GHashIterator to initialize.
+ * \param gh: The GHash to iterate over.
*/
void BLI_ghashIterator_init(GHashIterator *ghi, GHash *gh)
{
@@ -1083,7 +1083,7 @@ void BLI_ghashIterator_init(GHashIterator *ghi, GHash *gh)
/**
* Steps the iterator to the next index.
*
- * \param ghi The iterator.
+ * \param ghi: The iterator.
*/
void BLI_ghashIterator_step(GHashIterator *ghi)
{
@@ -1101,7 +1101,7 @@ void BLI_ghashIterator_step(GHashIterator *ghi)
/**
* Free a GHashIterator.
*
- * \param ghi The iterator to free.
+ * \param ghi: The iterator to free.
*/
void BLI_ghashIterator_free(GHashIterator *ghi)
{
@@ -1113,7 +1113,7 @@ void BLI_ghashIterator_free(GHashIterator *ghi)
/**
* Retrieve the key from an iterator.
*
- * \param ghi The iterator.
+ * \param ghi: The iterator.
* \return The key at the current index, or NULL if the
* iterator is done.
*/
@@ -1125,7 +1125,7 @@ void *BLI_ghashIterator_getKey(GHashIterator *ghi)
/**
* Retrieve the value from an iterator.
*
- * \param ghi The iterator.
+ * \param ghi: The iterator.
* \return The value at the current index, or NULL if the
* iterator is done.
*/
@@ -1137,7 +1137,7 @@ void *BLI_ghashIterator_getValue(GHashIterator *ghi)
/**
* Retrieve the value from an iterator.
*
- * \param ghi The iterator.
+ * \param ghi: The iterator.
* \return The value at the current index, or NULL if the
* iterator is done.
*/
@@ -1150,7 +1150,7 @@ void **BLI_ghashIterator_getValue_p(GHashIterator *ghi)
* Determine if an iterator is done (has reached the end of
* the hash table).
*
- * \param ghi The iterator.
+ * \param ghi: The iterator.
* \return True if done, False otherwise.
*/
bool BLI_ghashIterator_done(GHashIterator *ghi)
diff --git a/source/blender/blenlib/intern/BLI_kdtree.c b/source/blender/blenlib/intern/BLI_kdtree.c
index 80a2957d907..9265c8ee562 100644
--- a/source/blender/blenlib/intern/BLI_kdtree.c
+++ b/source/blender/blenlib/intern/BLI_kdtree.c
@@ -420,7 +420,7 @@ static void add_nearest(KDTreeNearest *ptn, uint *found, uint n, int index,
* Find n nearest returns number of points found, with results in nearest.
* Normal is optional, but if given will limit results to points in normal direction from co.
*
- * \param r_nearest An array of nearest, sized at least \a n.
+ * \param r_nearest: An array of nearest, sized at least \a n.
*/
int BLI_kdtree_find_nearest_n__normal(
const KDTree *tree, const float co[3], const float nor[3],
diff --git a/source/blender/blenlib/intern/BLI_mempool.c b/source/blender/blenlib/intern/BLI_mempool.c
index 3a65e6c42ca..b2cd7e58696 100644
--- a/source/blender/blenlib/intern/BLI_mempool.c
+++ b/source/blender/blenlib/intern/BLI_mempool.c
@@ -210,9 +210,9 @@ static BLI_mempool_chunk *mempool_chunk_alloc(BLI_mempool *pool)
/**
* Initialize a chunk and add into \a pool->chunks
*
- * \param pool The pool to add the chunk into.
- * \param mpchunk The new uninitialized chunk (can be malloc'd)
- * \param lasttail The last element of the previous chunk
+ * \param pool: The pool to add the chunk into.
+ * \param mpchunk: The new uninitialized chunk (can be malloc'd)
+ * \param lasttail: The last element of the previous chunk
* (used when building free chunks initially)
* \return The last chunk,
*/
@@ -501,8 +501,8 @@ void *BLI_mempool_findelem(BLI_mempool *pool, uint index)
* Fill in \a data with pointers to each element of the mempool,
* to create lookup table.
*
- * \param pool Pool to create a table from.
- * \param data array of pointers at least the size of 'pool->totused'
+ * \param pool: Pool to create a table from.
+ * \param data: array of pointers at least the size of 'pool->totused'
*/
void BLI_mempool_as_table(BLI_mempool *pool, void **data)
{
@@ -702,8 +702,8 @@ void *BLI_mempool_iterstep(BLI_mempool_iter *iter)
/**
* Empty the pool, as if it were just created.
*
- * \param pool The pool to clear.
- * \param totelem_reserve Optionally reserve how many items should be kept from clearing.
+ * \param pool: The pool to clear.
+ * \param totelem_reserve: Optionally reserve how many items should be kept from clearing.
*/
void BLI_mempool_clear_ex(BLI_mempool *pool, const int totelem_reserve)
{
diff --git a/source/blender/blenlib/intern/astar.c b/source/blender/blenlib/intern/astar.c
index 86c1faad096..0555d3e3df5 100644
--- a/source/blender/blenlib/intern/astar.c
+++ b/source/blender/blenlib/intern/astar.c
@@ -62,7 +62,7 @@
/**
* Init a node in A* graph.
*
- * \param custom_data an opaque pointer attached to this link, available e.g. to cost callback function.
+ * \param custom_data: an opaque pointer attached to this link, available e.g. to cost callback function.
*/
void BLI_astar_node_init(BLI_AStarGraph *as_graph, const int node_index, void *custom_data)
{
@@ -72,8 +72,8 @@ void BLI_astar_node_init(BLI_AStarGraph *as_graph, const int node_index, void *c
/**
* Add a link between two nodes of our A* graph.
*
- * \param cost the 'length' of the link (actual distance between two vertices or face centers e.g.).
- * \param custom_data an opaque pointer attached to this link, available e.g. to cost callback function.
+ * \param cost: the 'length' of the link (actual distance between two vertices or face centers e.g.).
+ * \param custom_data: an opaque pointer attached to this link, available e.g. to cost callback function.
*/
void BLI_astar_node_link_add(
BLI_AStarGraph *as_graph, const int node1_index, const int node2_index, const float cost, void *custom_data)
@@ -104,7 +104,7 @@ int BLI_astar_node_link_other_node(BLI_AStarGNLink *lnk, const int idx)
/**
* Initialize a solution data for given A* graph. Does not compute anything!
*
- * \param custom_data an opaque pointer attached to this link, available e.g. to cost callback function.
+ * \param custom_data: an opaque pointer attached to this link, available e.g. to cost callback function.
*
* \note BLI_AStarSolution stores nearly all data needed during solution compute.
*/
@@ -169,7 +169,7 @@ void BLI_astar_solution_free(BLI_AStarSolution *as_solution)
*
* Nodes might be e.g. vertices, faces, ...
*
- * \param custom_data an opaque pointer attached to this link, available e.g. to cost callback function.
+ * \param custom_data: an opaque pointer attached to this link, available e.g. to cost callback function.
*/
void BLI_astar_graph_init(BLI_AStarGraph *as_graph, const int node_num, void *custom_data)
{
@@ -198,7 +198,7 @@ void BLI_astar_graph_free(BLI_AStarGraph *as_graph)
/**
* Solve a path in given graph, using given 'cost' callback function.
*
- * \param max_steps maximum number of nodes the found path may have. Useful in performance-critical usages.
+ * \param max_steps: maximum number of nodes the found path may have. Useful in performance-critical usages.
* If no path is found within given steps, returns false too.
* \return true if a path was found, false otherwise.
*/
diff --git a/source/blender/blenlib/intern/convexhull_2d.c b/source/blender/blenlib/intern/convexhull_2d.c
index 38928dbbaa0..c4b408ba40f 100644
--- a/source/blender/blenlib/intern/convexhull_2d.c
+++ b/source/blender/blenlib/intern/convexhull_2d.c
@@ -60,9 +60,9 @@ static float is_left(const float p0[2], const float p1[2], const float p2[2])
/**
* A.M. Andrew's monotone chain 2D convex hull algorithm
*
- * \param points An array of 2D points presorted by increasing x and y-coords.
- * \param n The number of points in points.
- * \param r_points An array of the convex hull vertex indices (max is n).
+ * \param points: An array of 2D points presorted by increasing x and y-coords.
+ * \param n: The number of points in points.
+ * \param r_points: An array of the convex hull vertex indices (max is n).
* \returns the number of points in r_points.
*/
int BLI_convexhull_2d_sorted(const float (*points)[2], const int n, int r_points[])
@@ -184,9 +184,9 @@ static int pointref_cmp_yx(const void *a_, const void *b_)
/**
* A.M. Andrew's monotone chain 2D convex hull algorithm
*
- * \param points An array of 2D points.
- * \param n The number of points in points.
- * \param r_points An array of the convex hull vertex indices (max is n).
+ * \param points: An array of 2D points.
+ * \param n: The number of points in points.
+ * \param r_points: An array of the convex hull vertex indices (max is n).
* _must_ be allocated as ``n * 2`` because of how its used internally,
* even though the final result will be no more than \a n in size.
* \returns the number of points in r_points.
@@ -239,7 +239,7 @@ int BLI_convexhull_2d(const float (*points)[2], const int n, int r_points[])
*
* Intended to be used with #BLI_convexhull_2d
*
- * \param points_hull Ordered hull points
+ * \param points_hull: Ordered hull points
* (result of #BLI_convexhull_2d mapped to a contiguous array).
*
* \note we could return the index of the best edge too if its needed.
@@ -294,7 +294,7 @@ float BLI_convexhull_aabb_fit_hull_2d(const float (*points_hull)[2], unsigned in
/**
* Wrap #BLI_convexhull_aabb_fit_hull_2d and do the convex hull calculation.
*
- * \param points arbitrary 2d points.
+ * \param points: arbitrary 2d points.
*/
float BLI_convexhull_aabb_fit_points_2d(const float (*points)[2], unsigned int n)
{
diff --git a/source/blender/blenlib/intern/edgehash.c b/source/blender/blenlib/intern/edgehash.c
index 7074a776aaf..91b5f6486c5 100644
--- a/source/blender/blenlib/intern/edgehash.c
+++ b/source/blender/blenlib/intern/edgehash.c
@@ -475,7 +475,7 @@ void *BLI_edgehash_lookup_default(EdgeHash *eh, uint v0, uint v1, void *val_defa
* Remove \a key (v0, v1) from \a eh, or return false if the key wasn't found.
*
* \param v0, v1: The key to remove.
- * \param valfreefp Optional callback to free the value.
+ * \param valfreefp: Optional callback to free the value.
* \return true if \a key was removed from \a eh.
*/
bool BLI_edgehash_remove(EdgeHash *eh, uint v0, uint v1, EdgeHashFreeFP valfreefp)
@@ -613,8 +613,8 @@ EdgeHashIterator *BLI_edgehashIterator_new(EdgeHash *eh)
* be mutated while the iterator is in use, and the iterator will
* step exactly BLI_edgehash_len(eh) times before becoming done.
*
- * \param ehi The EdgeHashIterator to initialize.
- * \param eh The EdgeHash to iterate over.
+ * \param ehi: The EdgeHashIterator to initialize.
+ * \param eh: The EdgeHash to iterate over.
*/
void BLI_edgehashIterator_init(EdgeHashIterator *ehi, EdgeHash *eh)
{
diff --git a/source/blender/blenlib/intern/fileops.c b/source/blender/blenlib/intern/fileops.c
index 0b57a727452..82ddc5a63f5 100644
--- a/source/blender/blenlib/intern/fileops.c
+++ b/source/blender/blenlib/intern/fileops.c
@@ -550,12 +550,12 @@ static char *strip_last_slash(const char *dir)
* prefixing it with startto, recursively scanning subdirectories, and invoking the specified
* callbacks for files and subdirectories found as appropriate.
*
- * \param startfrom Top-level source path.
- * \param startto Top-level destination path.
- * \param callback_dir_pre Optional, to be invoked before entering a subdirectory, can return
+ * \param startfrom: Top-level source path.
+ * \param startto: Top-level destination path.
+ * \param callback_dir_pre: Optional, to be invoked before entering a subdirectory, can return
* RecursiveOp_Callback_StopRecurs to skip the subdirectory.
- * \param callback_file Optional, to be invoked on each file found.
- * \param callback_dir_post optional, to be invoked after leaving a subdirectory.
+ * \param callback_file: Optional, to be invoked on each file found.
+ * \param callback_dir_post: optional, to be invoked after leaving a subdirectory.
* \return
*/
static int recursive_operation(const char *startfrom, const char *startto,
diff --git a/source/blender/blenlib/intern/freetypefont.c b/source/blender/blenlib/intern/freetypefont.c
index b493b97863c..309bffeca00 100644
--- a/source/blender/blenlib/intern/freetypefont.c
+++ b/source/blender/blenlib/intern/freetypefont.c
@@ -453,7 +453,7 @@ static int check_freetypefont(PackedFile *pf)
* Construct a new VFontData structure from
* Freetype font data in a PackedFile.
*
- * \param pf The font data.
+ * \param pf: The font data.
* \retval A new VFontData structure, or NULL
* if unable to load.
*/
diff --git a/source/blender/blenlib/intern/gsqueue.c b/source/blender/blenlib/intern/gsqueue.c
index 29b882d0e99..4100a390e6f 100644
--- a/source/blender/blenlib/intern/gsqueue.c
+++ b/source/blender/blenlib/intern/gsqueue.c
@@ -58,7 +58,7 @@ struct _GSQueue {
/**
* Create a new GSQueue.
*
- * \param elem_size The size of the structures in the queue.
+ * \param elem_size: The size of the structures in the queue.
* \retval The new queue
*/
GSQueue *BLI_gsqueue_new(size_t elem_size)
@@ -131,7 +131,7 @@ void BLI_gsqueue_pop(GSQueue *gq, void *r_item)
/**
* Push an element onto the tail of the queue.
*
- * \param item A pointer to an appropriately
+ * \param item: A pointer to an appropriately
* sized structure (the size passed to BLI_gsqueue_new).
*/
void BLI_gsqueue_push(GSQueue *gq, const void *item)
@@ -159,7 +159,7 @@ void BLI_gsqueue_push(GSQueue *gq, const void *item)
* Push an element back onto the head of the queue (so
* it would be returned from the next call to BLI_gsqueue_pop).
*
- * \param item A pointer to an appropriately
+ * \param item: A pointer to an appropriately
* sized structure (the size passed to BLI_gsqueue_new).
*/
void BLI_gsqueue_push_back(GSQueue *gq, const void *item)
diff --git a/source/blender/blenlib/intern/listbase.c b/source/blender/blenlib/intern/listbase.c
index 568448327bd..cec2fdd5faf 100644
--- a/source/blender/blenlib/intern/listbase.c
+++ b/source/blender/blenlib/intern/listbase.c
@@ -795,7 +795,7 @@ void BLI_listbase_reverse(ListBase *lb)
}
/**
- * \param vlink Link to make first.
+ * \param vlink: Link to make first.
*/
void BLI_listbase_rotate_first(ListBase *lb, void *vlink)
{
@@ -811,7 +811,7 @@ void BLI_listbase_rotate_first(ListBase *lb, void *vlink)
}
/**
- * \param vlink Link to make last.
+ * \param vlink: Link to make last.
*/
void BLI_listbase_rotate_last(ListBase *lb, void *vlink)
{
diff --git a/source/blender/blenlib/intern/math_base_inline.c b/source/blender/blenlib/intern/math_base_inline.c
index 0f282805e71..647ab8aa478 100644
--- a/source/blender/blenlib/intern/math_base_inline.c
+++ b/source/blender/blenlib/intern/math_base_inline.c
@@ -348,7 +348,7 @@ MINLINE size_t clamp_z(size_t value, size_t min, size_t max)
/**
* Almost-equal for IEEE floats, using absolute difference method.
*
- * \param max_diff the maximum absolute difference.
+ * \param max_diff: the maximum absolute difference.
*/
MINLINE int compare_ff(float a, float b, const float max_diff)
{
@@ -358,9 +358,9 @@ MINLINE int compare_ff(float a, float b, const float max_diff)
/**
* Almost-equal for IEEE floats, using their integer representation (mixing ULP and absolute difference methods).
*
- * \param max_diff is the maximum absolute difference (allows to take care of the near-zero area,
+ * \param max_diff: is the maximum absolute difference (allows to take care of the near-zero area,
* where relative difference methods cannot really work).
- * \param max_ulps is the 'maximum number of floats + 1' allowed between \a a and \a b to consider them equal.
+ * \param max_ulps: is the 'maximum number of floats + 1' allowed between \a a and \a b to consider them equal.
*
* \see https://randomascii.wordpress.com/2012/02/25/comparing-floating-point-numbers-2012-edition/
*/
diff --git a/source/blender/blenlib/intern/math_geom.c b/source/blender/blenlib/intern/math_geom.c
index dca9d4204c3..eb6abfe2c32 100644
--- a/source/blender/blenlib/intern/math_geom.c
+++ b/source/blender/blenlib/intern/math_geom.c
@@ -361,9 +361,9 @@ void closest_to_line_segment_v3(float r_close[3], const float p[3], const float
/**
* Find the closest point on a plane.
*
- * \param r_close Return coordinate
- * \param plane The plane to test against.
- * \param pt The point to find the nearest of
+ * \param r_close: Return coordinate
+ * \param plane: The plane to test against.
+ * \param pt: The point to find the nearest of
*
* \note non-unit-length planes are supported.
*/
@@ -486,7 +486,7 @@ float dist_to_line_v3(const float p[3], const float l1[3], const float l2[3])
* Check if \a p is inside the 2x planes defined by ``(v1, v2, v3)``
* where the 3x points define 2x planes.
*
- * \param axis_ref used when v1,v2,v3 form a line and to check if the corner is concave/convex.
+ * \param axis_ref: used when v1,v2,v3 form a line and to check if the corner is concave/convex.
*
* \note the distance from \a v1 & \a v3 to \a v2 doesnt matter
* (it just defines the planes).
@@ -1852,11 +1852,11 @@ bool isect_point_planes_v3(float (*planes)[4], int totplane, const float p[3])
/**
* Intersect line/plane.
*
- * \param r_isect_co The intersection point.
- * \param l1 The first point of the line.
- * \param l2 The second point of the line.
- * \param plane_co A point on the plane to intersect with.
- * \param plane_no The direction of the plane (does not need to be normalized).
+ * \param r_isect_co: The intersection point.
+ * \param l1: The first point of the line.
+ * \param l2: The second point of the line.
+ * \param plane_co: A point on the plane to intersect with.
+ * \param plane_no: The direction of the plane (does not need to be normalized).
*
* \note #line_plane_factor_v3() shares logic.
*/
@@ -2929,8 +2929,8 @@ bool clip_segment_v3_plane_n(
* This matrix can be applied to vectors so their 'z' axis runs along \a normal.
* In practice it means you can use x,y as 2d coords. \see
*
- * \param r_mat The matrix to return.
- * \param normal A unit length vector.
+ * \param r_mat: The matrix to return.
+ * \param normal: A unit length vector.
*/
void axis_dominant_v3_to_m3(float r_mat[3][3], const float normal[3])
{
diff --git a/source/blender/blenlib/intern/math_geom_inline.c b/source/blender/blenlib/intern/math_geom_inline.c
index 68a2e68db4f..e0499e0eaa8 100644
--- a/source/blender/blenlib/intern/math_geom_inline.c
+++ b/source/blender/blenlib/intern/math_geom_inline.c
@@ -233,8 +233,8 @@ MINLINE int min_axis_v3(const float vec[3])
/**
* Simple method to find how many tri's we need when we already know the corner+poly count.
*
- * \param poly_count The number of ngon's/tris (1-2 sided faces will give incorrect results)
- * \param corner_count - also known as loops in BMesh/DNA
+ * \param poly_count: The number of ngon's/tris (1-2 sided faces will give incorrect results)
+ * \param corner_count: also known as loops in BMesh/DNA
*/
MINLINE int poly_to_tri_count(const int poly_count, const int corner_count)
{
diff --git a/source/blender/blenlib/intern/math_rotation.c b/source/blender/blenlib/intern/math_rotation.c
index f0c830d33c6..726ad5ea7fe 100644
--- a/source/blender/blenlib/intern/math_rotation.c
+++ b/source/blender/blenlib/intern/math_rotation.c
@@ -966,9 +966,9 @@ void eulO_to_axis_angle(float axis[3], float *angle, const float eul[3], const s
*
* This takes the angle with sin/cos applied so we can avoid calculating it in some cases.
*
- * \param axis rotation axis (must be normalized).
- * \param angle_sin sin(angle)
- * \param angle_cos cos(angle)
+ * \param axis: rotation axis (must be normalized).
+ * \param angle_sin: sin(angle)
+ * \param angle_cos: cos(angle)
*/
void axis_angle_normalized_to_mat3_ex(float mat[3][3], const float axis[3],
const float angle_sin, const float angle_cos)
diff --git a/source/blender/blenlib/intern/math_solvers.c b/source/blender/blenlib/intern/math_solvers.c
index e3174d8340a..1c4323c871a 100644
--- a/source/blender/blenlib/intern/math_solvers.c
+++ b/source/blender/blenlib/intern/math_solvers.c
@@ -41,7 +41,7 @@
/**
* \brief Compute the eigen values and/or vectors of given 3D symmetric (aka adjoint) matrix.
*
- * \param m3 the 3D symmetric matrix.
+ * \param m3: the 3D symmetric matrix.
* \return r_eigen_values the computed eigen values (NULL if not needed).
* \return r_eigen_vectors the computed eigen vectors (NULL if not needed).
*/
@@ -63,7 +63,7 @@ bool BLI_eigen_solve_selfadjoint_m3(const float m3[3][3], float r_eigen_values[3
/**
* \brief Compute the SVD (Singular Values Decomposition) of given 3D matrix (m3 = USV*).
*
- * \param m3 the matrix to decompose.
+ * \param m3: the matrix to decompose.
* \return r_U the computed left singular vector of \a m3 (NULL if not needed).
* \return r_S the computed singular values of \a m3 (NULL if not needed).
* \return r_V the computed right singular vector of \a m3 (NULL if not needed).
@@ -82,7 +82,7 @@ void BLI_svd_m3(const float m3[3][3], float r_U[3][3], float r_S[3], float r_V[3
*
* Ignores a[0] and c[count-1]. Uses the Thomas algorithm, e.g. see wiki.
*
- * \param r_x output vector, may be shared with any of the input ones
+ * \param r_x: output vector, may be shared with any of the input ones
* \return true if success
*/
bool BLI_tridiagonal_solve(const float *a, const float *b, const float *c, const float *d, float *r_x, const int count)
@@ -130,7 +130,7 @@ bool BLI_tridiagonal_solve(const float *a, const float *b, const float *c, const
/**
* \brief Solve a possibly cyclic tridiagonal system using the Sherman-Morrison formula.
*
- * \param r_x output vector, may be shared with any of the input ones
+ * \param r_x: output vector, may be shared with any of the input ones
* \return true if success
*/
bool BLI_tridiagonal_solve_cyclic(const float *a, const float *b, const float *c, const float *d, float *r_x, const int count)
diff --git a/source/blender/blenlib/intern/math_statistics.c b/source/blender/blenlib/intern/math_statistics.c
index 3a19f1d3603..bc565fef6c6 100644
--- a/source/blender/blenlib/intern/math_statistics.c
+++ b/source/blender/blenlib/intern/math_statistics.c
@@ -96,11 +96,11 @@ static void covariance_m_vn_ex_task_cb(
/**
* \brief Compute the covariance matrix of given set of nD coordinates.
*
- * \param n the dimension of the vectors (and hence, of the covariance matrix to compute).
- * \param cos_vn the nD points to compute covariance from.
- * \param nbr_cos_vn the number of nD coordinates in cos_vn.
- * \param center the center (or mean point) of cos_vn. If NULL, it is assumed cos_vn is already centered.
- * \param use_sample_correction whether to apply sample correction
+ * \param n: the dimension of the vectors (and hence, of the covariance matrix to compute).
+ * \param cos_vn: the nD points to compute covariance from.
+ * \param nbr_cos_vn: the number of nD coordinates in cos_vn.
+ * \param center: the center (or mean point) of cos_vn. If NULL, it is assumed cos_vn is already centered.
+ * \param use_sample_correction: whether to apply sample correction
* (i.e. get 'sample varince' instead of 'population variance').
* \return r_covmat the computed covariance matrix.
*/
@@ -133,8 +133,8 @@ void BLI_covariance_m_vn_ex(
/**
* \brief Compute the covariance matrix of given set of 3D coordinates.
*
- * \param cos_v3 the 3D points to compute covariance from.
- * \param nbr_cos_v3 the number of 3D coordinates in cos_v3.
+ * \param cos_v3: the 3D points to compute covariance from.
+ * \param nbr_cos_v3: the number of 3D coordinates in cos_v3.
* \return r_covmat the computed covariance matrix.
* \return r_center the computed center (mean) of 3D points (may be NULL).
*/
diff --git a/source/blender/blenlib/intern/path_util.c b/source/blender/blenlib/intern/path_util.c
index 84c932db1c7..04c711f718c 100644
--- a/source/blender/blenlib/intern/path_util.c
+++ b/source/blender/blenlib/intern/path_util.c
@@ -80,10 +80,10 @@ static bool BLI_path_is_abs(const char *name);
* Looks for a sequence of decimal digits in string, preceding any filename extension,
* returning the integer value if found, or 0 if not.
*
- * \param string String to scan.
- * \param head Optional area to return copy of part of string prior to digits, or before dot if no digits.
- * \param tail Optional area to return copy of part of string following digits, or from dot if no digits.
- * \param numlen Optional to return number of digits found.
+ * \param string: String to scan.
+ * \param head: Optional area to return copy of part of string prior to digits, or before dot if no digits.
+ * \param tail: Optional area to return copy of part of string following digits, or from dot if no digits.
+ * \param numlen: Optional to return number of digits found.
*/
int BLI_stringdec(const char *string, char *head, char *tail, ushort *r_num_len)
{
@@ -652,10 +652,10 @@ void BLI_path_rel(char *file, const char *relfile)
* string = Foo.png, suffix = 123, separator = _
* Foo.png -> Foo_123.png
*
- * \param string original (and final) string
- * \param maxlen Maximum length of string
- * \param suffix String to append to the original string
- * \param sep Optional separator character
+ * \param string: original (and final) string
+ * \param maxlen: Maximum length of string
+ * \param suffix: String to append to the original string
+ * \param sep: Optional separator character
* \return true if succeeded
*/
bool BLI_path_suffix(char *string, size_t maxlen, const char *suffix, const char *sep)
@@ -1282,8 +1282,8 @@ bool BLI_make_existing_file(const char *name)
* separators, including ensuring there is exactly one between the copies of *dir and *file,
* and between the copies of *relabase and *dir.
*
- * \param relabase Optional prefix to substitute for "//" on front of *dir
- * \param string Area to return result
+ * \param relabase: Optional prefix to substitute for "//" on front of *dir
+ * \param string: Area to return result
*/
void BLI_make_file_string(const char *relabase, char *string, const char *dir, const char *file)
{
diff --git a/source/blender/blenlib/intern/string.c b/source/blender/blenlib/intern/string.c
index c1696a912ba..66b9cee50c3 100644
--- a/source/blender/blenlib/intern/string.c
+++ b/source/blender/blenlib/intern/string.c
@@ -54,8 +54,8 @@
* into a newly mallocN'd string and returns it. \a str
* is assumed to be at least len bytes long.
*
- * \param str The string to be duplicated
- * \param len The number of bytes to duplicate
+ * \param str: The string to be duplicated
+ * \param len: The number of bytes to duplicate
* \retval Returns the duplicated string
*/
char *BLI_strdupn(const char *str, const size_t len)
@@ -71,7 +71,7 @@ char *BLI_strdupn(const char *str, const size_t len)
* Duplicates the cstring \a str into a newly mallocN'd
* string and returns it.
*
- * \param str The string to be duplicated
+ * \param str: The string to be duplicated
* \retval Returns the duplicated string
*/
char *BLI_strdup(const char *str)
@@ -81,8 +81,8 @@ char *BLI_strdup(const char *str)
/**
* Appends the two strings, and returns new mallocN'ed string
- * \param str1 first string for copy
- * \param str2 second string for append
+ * \param str1: first string for copy
+ * \param str2: second string for append
* \retval Returns dst
*/
char *BLI_strdupcat(const char *__restrict str1, const char *__restrict str2)
@@ -105,9 +105,9 @@ char *BLI_strdupcat(const char *__restrict str1, const char *__restrict str2)
* Like strncpy but ensures dst is always
* '\0' terminated.
*
- * \param dst Destination for copy
- * \param src Source string to copy
- * \param maxncpy Maximum number of characters to copy (generally
+ * \param dst: Destination for copy
+ * \param src: Source string to copy
+ * \param maxncpy: Maximum number of characters to copy (generally
* the size of dst)
* \retval Returns dst
*/
@@ -128,10 +128,10 @@ char *BLI_strncpy(char *__restrict dst, const char *__restrict src, const size_t
/**
* Like BLI_strncpy but ensures dst is always padded by given char, on both sides (unless src is empty).
*
- * \param dst Destination for copy
- * \param src Source string to copy
- * \param pad the char to use for padding
- * \param maxncpy Maximum number of characters to copy (generally the size of dst)
+ * \param dst: Destination for copy
+ * \param src: Source string to copy
+ * \param pad: the char to use for padding
+ * \param maxncpy: Maximum number of characters to copy (generally the size of dst)
* \retval Returns dst
*/
char *BLI_strncpy_ensure_pad(char *__restrict dst, const char *__restrict src, const char pad, size_t maxncpy)
@@ -180,9 +180,9 @@ char *BLI_strncpy_ensure_pad(char *__restrict dst, const char *__restrict src, c
* \note This is a duplicate of #BLI_strncpy that returns bytes copied.
* And is a drop in replacement for 'snprintf(str, sizeof(str), "%s", arg);'
*
- * \param dst Destination for copy
- * \param src Source string to copy
- * \param maxncpy Maximum number of characters to copy (generally
+ * \param dst: Destination for copy
+ * \param src: Source string to copy
+ * \param maxncpy: Maximum number of characters to copy (generally
* the size of dst)
* \retval The number of bytes copied (The only difference from BLI_strncpy).
*/
@@ -412,9 +412,9 @@ char *BLI_str_quoted_substrN(const char *__restrict str, const char *__restrict
* \note A rather wasteful string-replacement utility, though this shall do for now...
* Feel free to replace this with an even safe + nicer alternative
*
- * \param str The string to replace occurrences of substr_old in
- * \param substr_old The text in the string to find and replace
- * \param substr_new The text in the string to find and replace
+ * \param str: The string to replace occurrences of substr_old in
+ * \param substr_old: The text in the string to find and replace
+ * \param substr_new: The text in the string to find and replace
* \retval Returns the duplicated string
*/
char *BLI_str_replaceN(const char *__restrict str, const char *__restrict substr_old, const char *__restrict substr_new)
@@ -783,8 +783,8 @@ void BLI_str_toupper_ascii(char *str, const size_t len)
* 0.0000 -> 0.0
* 2.0010 -> 2.001
*
- * \param str
- * \param pad
+ * \param str:
+ * \param pad:
* \return The number of zeros stripped.
*/
int BLI_str_rstrip_float_zero(char *str, const char pad)
@@ -810,9 +810,9 @@ int BLI_str_rstrip_float_zero(char *str, const char pad)
/**
* Return index of a string in a string array.
*
- * \param str The string to find.
- * \param str_array Array of strings.
- * \param str_array_len The length of the array, or -1 for a NULL-terminated array.
+ * \param str: The string to find.
+ * \param str_array: Array of strings.
+ * \param str_array_len: The length of the array, or -1 for a NULL-terminated array.
* \return The index of str in str_array or -1.
*/
int BLI_str_index_in_array_n(const char *__restrict str, const char **__restrict str_array, const int str_array_len)
@@ -831,8 +831,8 @@ int BLI_str_index_in_array_n(const char *__restrict str, const char **__restrict
/**
* Return index of a string in a string array.
*
- * \param str The string to find.
- * \param str_array Array of strings, (must be NULL-terminated).
+ * \param str: The string to find.
+ * \param str_array: Array of strings, (must be NULL-terminated).
* \return The index of str in str_array or -1.
*/
int BLI_str_index_in_array(const char *__restrict str, const char **__restrict str_array)
@@ -867,8 +867,8 @@ bool BLI_strn_endswith(const char *__restrict str, const char *__restrict end, s
/**
* Find if a string ends with another string.
*
- * \param str The string to search within.
- * \param end The string we look for at the end.
+ * \param str: The string to search within.
+ * \param end: The string we look for at the end.
* \return If str ends with end.
*/
bool BLI_str_endswith(const char *__restrict str, const char * __restrict end)
@@ -880,10 +880,10 @@ bool BLI_str_endswith(const char *__restrict str, const char * __restrict end)
/**
* Find the first char matching one of the chars in \a delim, from left.
*
- * \param str The string to search within.
- * \param delim The set of delimiters to search for, as unicode values.
- * \param sep Return value, set to the first delimiter found (or NULL if none found).
- * \param suf Return value, set to next char after the first delimiter found (or NULL if none found).
+ * \param str: The string to search within.
+ * \param delim: The set of delimiters to search for, as unicode values.
+ * \param sep: Return value, set to the first delimiter found (or NULL if none found).
+ * \param suf: Return value, set to next char after the first delimiter found (or NULL if none found).
* \return The length of the prefix (i.e. *sep - str).
*/
size_t BLI_str_partition(const char *str, const char delim[], const char **sep, const char **suf)
@@ -894,10 +894,10 @@ size_t BLI_str_partition(const char *str, const char delim[], const char **sep,
/**
* Find the first char matching one of the chars in \a delim, from right.
*
- * \param str The string to search within.
- * \param delim The set of delimiters to search for, as unicode values.
- * \param sep Return value, set to the first delimiter found (or NULL if none found).
- * \param suf Return value, set to next char after the first delimiter found (or NULL if none found).
+ * \param str: The string to search within.
+ * \param delim: The set of delimiters to search for, as unicode values.
+ * \param sep: Return value, set to the first delimiter found (or NULL if none found).
+ * \param suf: Return value, set to next char after the first delimiter found (or NULL if none found).
* \return The length of the prefix (i.e. *sep - str).
*/
size_t BLI_str_rpartition(const char *str, const char delim[], const char **sep, const char **suf)
@@ -908,12 +908,12 @@ size_t BLI_str_rpartition(const char *str, const char delim[], const char **sep,
/**
* Find the first char matching one of the chars in \a delim, either from left or right.
*
- * \param str The string to search within.
- * \param end If non-NULL, the right delimiter of the string.
- * \param delim The set of delimiters to search for, as unicode values.
- * \param sep Return value, set to the first delimiter found (or NULL if none found).
- * \param suf Return value, set to next char after the first delimiter found (or NULL if none found).
- * \param from_right If %true, search from the right of \a str, else, search from its left.
+ * \param str: The string to search within.
+ * \param end: If non-NULL, the right delimiter of the string.
+ * \param delim: The set of delimiters to search for, as unicode values.
+ * \param sep: Return value, set to the first delimiter found (or NULL if none found).
+ * \param suf: Return value, set to next char after the first delimiter found (or NULL if none found).
+ * \param from_right: If %true, search from the right of \a str, else, search from its left.
* \return The length of the prefix (i.e. *sep - str).
*/
size_t BLI_str_partition_ex(
@@ -964,8 +964,8 @@ size_t BLI_str_partition_ex(
* Format ints with decimal grouping.
* 1000 -> 1,000
*
- * \param dst The resulting string
- * \param num Number to format
+ * \param dst: The resulting string
+ * \param num: Number to format
* \return The length of \a dst
*/
size_t BLI_str_format_int_grouped(char dst[16], int num)
@@ -1000,9 +1000,9 @@ size_t BLI_str_format_int_grouped(char dst[16], int num)
* 1000 -> 1 KB
* Number of decimal places grows with the used unit (e.g. 1.5 MB, 1.55 GB, 1.545 TB).
*
- * \param dst The resulting string. Dimension of 14 to support largest possible value for \a bytes (LLONG_MAX).
- * \param bytes Number to format
- * \param base_10 Calculate using base 10 (GB, MB, ...) or 2 (GiB, MiB, ...)
+ * \param dst: The resulting string. Dimension of 14 to support largest possible value for \a bytes (LLONG_MAX).
+ * \param bytes: Number to format
+ * \param base_10: Calculate using base 10 (GB, MB, ...) or 2 (GiB, MiB, ...)
*/
void BLI_str_format_byte_unit(char dst[15], long long int bytes, const bool base_10)
{
diff --git a/source/blender/blenlib/intern/string_utf8.c b/source/blender/blenlib/intern/string_utf8.c
index b41f7d0be66..1e2a9629e0f 100644
--- a/source/blender/blenlib/intern/string_utf8.c
+++ b/source/blender/blenlib/intern/string_utf8.c
@@ -515,7 +515,7 @@ int BLI_str_utf8_size_safe(const char *p)
/* was g_utf8_get_char */
/**
* BLI_str_utf8_as_unicode:
- * \param p a pointer to Unicode character encoded as UTF-8
+ * \param p: a pointer to Unicode character encoded as UTF-8
*
* Converts a sequence of bytes encoded as UTF-8 to a Unicode character.
* If \a p does not point to a valid UTF-8 encoded character, results are
@@ -677,8 +677,8 @@ size_t BLI_str_utf8_from_unicode(uint c, char *outbuf)
/* was g_utf8_find_prev_char */
/**
* BLI_str_find_prev_char_utf8:
- * \param str pointer to the beginning of a UTF-8 encoded string
- * \param p pointer to some position within \a str
+ * \param str: pointer to the beginning of a UTF-8 encoded string
+ * \param p: pointer to some position within \a str
*
* Given a position \a p with a UTF-8 encoded string \a str, find the start
* of the previous UTF-8 character starting before. \a p Returns %NULL if no
@@ -703,8 +703,8 @@ char *BLI_str_find_prev_char_utf8(const char *str, const char *p)
/* was g_utf8_find_next_char */
/**
* BLI_str_find_next_char_utf8:
- * \param p a pointer to a position within a UTF-8 encoded string
- * \param end a pointer to the byte following the end of the string,
+ * \param p: a pointer to a position within a UTF-8 encoded string
+ * \param end: a pointer to the byte following the end of the string,
* or %NULL to indicate that the string is nul-terminated.
*
* Finds the start of the next UTF-8 character in the string after \a p
@@ -735,7 +735,7 @@ char *BLI_str_find_next_char_utf8(const char *p, const char *end)
/* was g_utf8_prev_char */
/**
* BLI_str_prev_char_utf8:
- * \param p a pointer to a position within a UTF-8 encoded string
+ * \param p: a pointer to a position within a UTF-8 encoded string
*
* Finds the previous UTF-8 character in the string before \a p
*
diff --git a/source/blender/blenlib/intern/string_utils.c b/source/blender/blenlib/intern/string_utils.c
index 296086ed652..ca7894cf115 100644
--- a/source/blender/blenlib/intern/string_utils.c
+++ b/source/blender/blenlib/intern/string_utils.c
@@ -55,10 +55,10 @@
* Foo.001 -> "Foo", 1
* Returning the length of "Foo"
*
- * \param left Where to return copy of part preceding delim
- * \param nr Where to return value of numeric suffix
- * \param name String to split
- * \param delim Delimiter character
+ * \param left: Where to return copy of part preceding delim
+ * \param nr: Where to return value of numeric suffix
+ * \param name: String to split
+ * \param delim: Delimiter character
* \return Length of \a left
*/
size_t BLI_split_name_num(char *left, int *nr, const char *name, const char delim)
@@ -142,9 +142,9 @@ void BLI_string_split_prefix(const char *string, char *r_pre, char *r_body, cons
/**
* Finds the best possible flipped (left/right) name. For renaming; check for unique names afterwards.
*
- * \param r_name flipped name, assumed to be a pointer to a string of at least \a name_len size.
- * \param from_name original name, assumed to be a pointer to a string of at least \a name_len size.
- * \param strip_number If set, remove number extensions.
+ * \param r_name: flipped name, assumed to be a pointer to a string of at least \a name_len size.
+ * \param from_name: original name, assumed to be a pointer to a string of at least \a name_len size.
+ * \param strip_number: If set, remove number extensions.
*/
void BLI_string_flip_side_name(char *r_name, const char *from_name, const bool strip_number, const size_t name_len)
{
@@ -275,12 +275,12 @@ void BLI_string_flip_side_name(char *r_name, const char *from_name, const bool s
* Ensures name is unique (according to criteria specified by caller in unique_check callback),
* incrementing its numeric suffix as necessary. Returns true if name had to be adjusted.
*
- * \param unique_check Return true if name is not unique
- * \param arg Additional arg to unique_check--meaning is up to caller
- * \param defname To initialize name if latter is empty
- * \param delim Delimits numeric suffix in name
- * \param name Name to be ensured unique
- * \param name_len Maximum length of name area
+ * \param unique_check: Return true if name is not unique
+ * \param arg: Additional arg to unique_check--meaning is up to caller
+ * \param defname: To initialize name if latter is empty
+ * \param delim: Delimits numeric suffix in name
+ * \param name: Name to be ensured unique
+ * \param name_len: Maximum length of name area
* \return true if there if the name was changed
*/
bool BLI_uniquename_cb(
@@ -359,12 +359,12 @@ static bool uniquename_unique_check(void *arg, const char *name)
* Ensures that the specified block has a unique name within the containing list,
* incrementing its numeric suffix as necessary. Returns true if name had to be adjusted.
*
- * \param list List containing the block
- * \param vlink The block to check the name for
- * \param defname To initialize block name if latter is empty
- * \param delim Delimits numeric suffix in name
- * \param name_offs Offset of name within block structure
- * \param name_len Maximum length of name area
+ * \param list: List containing the block
+ * \param vlink: The block to check the name for
+ * \param defname: To initialize block name if latter is empty
+ * \param delim: Delimits numeric suffix in name
+ * \param name_offs: Offset of name within block structure
+ * \param name_len: Maximum length of name area
*/
bool BLI_uniquename(ListBase *list, void *vlink, const char *defname, char delim, int name_offs, size_t name_len)
{
diff --git a/source/blender/blenlib/intern/task.c b/source/blender/blenlib/intern/task.c
index f71c0d7a748..c05634d3062 100644
--- a/source/blender/blenlib/intern/task.c
+++ b/source/blender/blenlib/intern/task.c
@@ -1249,10 +1249,10 @@ BLI_INLINE int task_parallel_listbasecalc_chunk_size(const int num_threads)
/**
* This function allows to parallelize for loops over ListBase items.
*
- * \param listbase The double linked list to loop over.
- * \param userdata Common userdata passed to all instances of \a func.
- * \param func Callback function.
- * \param use_threading If \a true, actually split-execute loop in threads, else just do a sequential forloop
+ * \param listbase: The double linked list to loop over.
+ * \param userdata: Common userdata passed to all instances of \a func.
+ * \param func: Callback function.
+ * \param use_threading: If \a true, actually split-execute loop in threads, else just do a sequential forloop
* (allows caller to use any kind of test to switch on parallelization or not).
*
* \note There is no static scheduling here, since it would need another full loop over items to count them...
diff --git a/source/blender/blenlib/intern/timecode.c b/source/blender/blenlib/intern/timecode.c
index f59c493206f..ab7766d2cd6 100644
--- a/source/blender/blenlib/intern/timecode.c
+++ b/source/blender/blenlib/intern/timecode.c
@@ -46,13 +46,13 @@
/**
* Generate timecode/frame number string and store in \a str
*
- * \param str destination string
- * \param maxncpy maximum number of characters to copy ``sizeof(str)``
- * \param power special setting for #View2D grid drawing,
+ * \param str: destination string
+ * \param maxncpy: maximum number of characters to copy ``sizeof(str)``
+ * \param power: special setting for #View2D grid drawing,
* used to specify how detailed we need to be
- * \param time_seconds time total time in seconds
- * \param fps frames per second, typically from the #FPS macro
- * \param timecode_style enum from eTimecodeStyles
+ * \param time_seconds: time total time in seconds
+ * \param fps: frames per second, typically from the #FPS macro
+ * \param timecode_style: enum from eTimecodeStyles
* \return length of \a str
*/
@@ -231,11 +231,11 @@ size_t BLI_timecode_string_from_time_simple(
/**
* Generate time string and store in \a str
*
- * \param str destination string
- * \param maxncpy maximum number of characters to copy ``sizeof(str)``
- * \param power special setting for #View2D grid drawing,
+ * \param str: destination string
+ * \param maxncpy: maximum number of characters to copy ``sizeof(str)``
+ * \param power: special setting for #View2D grid drawing,
* used to specify how detailed we need to be
- * \param time_seconds time total time in seconds
+ * \param time_seconds: time total time in seconds
* \return length of \a str
*
* \note in some cases this is used to print non-seconds values.