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>2020-09-08 02:10:17 +0300
committerCampbell Barton <ideasman42@gmail.com>2020-09-08 02:18:59 +0300
commitbedc68a83881b209b399bb5135fb08b0968b145a (patch)
treed0c6ce7458efee6e6b3926963922823e01543cf5 /source/blender/blenkernel
parent5c2ac8520e070db2085b7d95d9d232b567edb247 (diff)
Cleanup: consistent syntax for doxygen parameters
Also use back-slash instead of '@'.
Diffstat (limited to 'source/blender/blenkernel')
-rw-r--r--source/blender/blenkernel/intern/collection.c10
-rw-r--r--source/blender/blenkernel/intern/lib_override.c24
-rw-r--r--source/blender/blenkernel/intern/unit.c2
3 files changed, 18 insertions, 18 deletions
diff --git a/source/blender/blenkernel/intern/collection.c b/source/blender/blenkernel/intern/collection.c
index 8975be2b618..836ce542793 100644
--- a/source/blender/blenkernel/intern/collection.c
+++ b/source/blender/blenkernel/intern/collection.c
@@ -1182,10 +1182,10 @@ static bool collection_instance_find_recursive(Collection *collection,
/**
* Find potential cycles in collections.
*
- * \param new_ancestor the potential new owner of given \a collection, or the collection to check
- * if the later is NULL.
- * \param collection the collection we want to add to \a new_ancestor, may be NULL if we just want
- * to ensure \a new_ancestor does not already have cycles.
+ * \param new_ancestor: the potential new owner of given \a collection,
+ * or the collection to check if the later is NULL.
+ * \param collection: the collection we want to add to \a new_ancestor,
+ * may be NULL if we just want to ensure \a new_ancestor does not already have cycles.
* \return true if a cycle is found.
*/
bool BKE_collection_cycle_find(Collection *new_ancestor, Collection *collection)
@@ -1254,7 +1254,7 @@ static bool collection_cycle_fix_recursive(Main *bmain,
/**
* Find and fix potential cycles in collections.
*
- * \param collection the collection to check for existing cycles.
+ * \param collection: The collection to check for existing cycles.
* \return true if cycles are found and fixed.
*/
bool BKE_collection_cycles_fix(Main *bmain, Collection *collection)
diff --git a/source/blender/blenkernel/intern/lib_override.c b/source/blender/blenkernel/intern/lib_override.c
index 2908ef133f0..48ecbcae90c 100644
--- a/source/blender/blenkernel/intern/lib_override.c
+++ b/source/blender/blenkernel/intern/lib_override.c
@@ -409,9 +409,9 @@ static bool lib_override_hierarchy_recursive_tag(Main *bmain,
*
* This will include all local IDs, and all IDs from the same library as the \a id_root.
*
- * \param id_root The root of the hierarchy of dependencies to be tagged.
- * \param do_create_main_relashionships Whether main relations needs to be created or already exist
- * (in any case, they will be freed by this function).
+ * \param id_root: The root of the hierarchy of dependencies to be tagged.
+ * \param do_create_main_relashionships: Whether main relations needs to be created or already
+ * exist (in any case, they will be freed by this function).
*/
void BKE_lib_override_library_dependencies_tag(Main *bmain,
ID *id_root,
@@ -435,9 +435,9 @@ void BKE_lib_override_library_dependencies_tag(Main *bmain,
* That is, all other liboverrides IDs (in)directly used by \a is_root one, sharing the same
* library for their reference IDs.
*
- * \param id_root The root of the hierarchy of liboverride dependencies to be tagged.
- * \param do_create_main_relashionships Whether main relations needs to be created or already exist
- * (in any case, they will be freed by this function).
+ * \param id_root: The root of the hierarchy of liboverride dependencies to be tagged.
+ * \param do_create_main_relashionships: Whether main relations needs to be created or already
+ * exist (in any case, they will be freed by this function).
*/
void BKE_lib_override_library_override_group_tag(Main *bmain,
ID *id_root,
@@ -640,10 +640,10 @@ static void lib_override_library_create_post_process(
* \note In the future that same function may be extended to support 'refresh' of overrides
* (rebuilding overrides from linked data, trying to preserve local overrides already defined).
*
- * \param id_root The root ID to create an override from.
- * \param id_reference some reference ID used to do some post-processing after overrides have been
- * created, may be NULL. Typically, the Empty object instantiating the linked
- * collection we override, currently.
+ * \param id_root: The root ID to create an override from.
+ * \param id_reference: Some reference ID used to do some post-processing after overrides have been
+ * created, may be NULL. Typically, the Empty object instantiating the linked
+ * collection we override, currently.
* \return true if override was successfully created.
*/
bool BKE_lib_override_library_create(
@@ -668,7 +668,7 @@ bool BKE_lib_override_library_create(
* Advanced 'smart' function to resync, re-create fully functional overrides up-to-date with linked
* data, from an existing override hierarchy.
*
- * \param id_root The root liboverride ID to resync from.
+ * \param id_root: The root liboverride ID to resync from.
* \return true if override was successfully resynced.
*/
bool BKE_lib_override_library_resync(Main *bmain, Scene *scene, ViewLayer *view_layer, ID *id_root)
@@ -790,7 +790,7 @@ bool BKE_lib_override_library_resync(Main *bmain, Scene *scene, ViewLayer *view_
*
* \note All IDs tagged with `LIB_TAG_DOIT` will be deleted.
*
- * \param id_root The root liboverride ID to resync from.
+ * \param id_root: The root liboverride ID to resync from.
*/
void BKE_lib_override_library_delete(Main *bmain, ID *id_root)
{
diff --git a/source/blender/blenkernel/intern/unit.c b/source/blender/blenkernel/intern/unit.c
index c5782d846bb..babb4965b1e 100644
--- a/source/blender/blenkernel/intern/unit.c
+++ b/source/blender/blenkernel/intern/unit.c
@@ -1099,7 +1099,7 @@ double bUnit_ApplyPreferredUnit(const struct UnitSettings *settings, int type, d
* Values will be split by an add sign.
* 5'2" -> 5*0.3048 + 2*0.0254
*
- * \param str_prev is optional, when valid it is used to get a base unit when none is set.
+ * \param str_prev: is optional, when valid it is used to get a base unit when none is set.
*
* \return True of a change was made.
*/