[Bf-blender-cvs] [97de4f07a38] master: Cleanup: doxy sections, parameter syntax

[Campbell Barton]

Commit: 97de4f07a3872365f7924f7c31980eebb79041d0
Author: Campbell Barton
Date:   Wed Sep 15 10:50:33 2021 +1000
Branches: master
https://developer.blender.org/rB97de4f07a3872365f7924f7c31980eebb79041d0

Cleanup: doxy sections, parameter syntax

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

M	source/blender/blenkernel/intern/lib_id.c
M	source/blender/blenkernel/intern/lib_override.c
M	source/blender/blenkernel/intern/lib_query.c
M	source/blender/blenkernel/intern/undo_system.c
M	source/blender/blenlib/tests/BLI_color_test.cc
M	source/blender/compositor/intern/COM_WorkScheduler.cc
M	source/blender/compositor/nodes/COM_CryptomatteNode.cc
M	source/blender/windowmanager/intern/wm_files_link.c

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

diff --git a/source/blender/blenkernel/intern/lib_id.c b/source/blender/blenkernel/intern/lib_id.c
index 66b83272769..4d7d675e364 100644
--- a/source/blender/blenkernel/intern/lib_id.c
+++ b/source/blender/blenkernel/intern/lib_id.c
@@ -1706,7 +1706,7 @@ static bool check_for_dupid(ListBase *lb, ID *id, char *name, ID **r_id_sorting_
  *
  * Only for local IDs (linked ones already have a unique ID in their library).
  *
- * \param do_linked_data if true, also ensure a unique name in case the given \a id is linked
+ * \param do_linked_data: if true, also ensure a unique name in case the given \a id is linked
  * (otherwise, just ensure that it is properly sorted).
  *
  * \return true if a new name had to be created.
diff --git a/source/blender/blenkernel/intern/lib_override.c b/source/blender/blenkernel/intern/lib_override.c
index 8c1e04838df..3fead8b0f39 100644
--- a/source/blender/blenkernel/intern/lib_override.c
+++ b/source/blender/blenkernel/intern/lib_override.c
@@ -333,11 +333,11 @@ ID *BKE_lib_override_library_create_from_id(Main *bmain,
  * main. You can add more local IDs to be remapped to use new overriding ones by setting their
  * LIB_TAG_DOIT tag.
  *
- * \param reference_library the library from which the linked data being overridden come from
+ * \param reference_library: the library from which the linked data being overridden come from
  * (i.e. the library of the linked reference ID).
  *
- * \param do_no_main Create the new override data outside of Main database. Used for resyncing of
- * linked overrides.
+ * \param do_no_main: Create the new override data outside of Main database.
+ * Used for resyncing of linked overrides.
  *
  * \return \a true on success, \a false otherwise.
  */
@@ -901,7 +901,7 @@ static void lib_override_library_create_post_process(Main *bmain,
  * \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 r_id_root_override if not NULL, the override generated for the given \a id_root.
+ * \param r_id_root_override: if not NULL, the override generated for the given \a id_root.
  * \return true if override was successfully created.
  */
 bool BKE_lib_override_library_create(Main *bmain,
diff --git a/source/blender/blenkernel/intern/lib_query.c b/source/blender/blenkernel/intern/lib_query.c
index 36cbf35b251..2ac92828cec 100644
--- a/source/blender/blenkernel/intern/lib_query.c
+++ b/source/blender/blenkernel/intern/lib_query.c
@@ -720,9 +720,9 @@ static void lib_query_unused_ids_tag_recurse(Main *bmain,
  * Valid usages here are defined as ref-counting usages, which are not towards embedded or
  * loop-back data.
  *
- * \param r_num_tagged If non-NULL, must be a zero-initialized array of #INDEX_ID_MAX integers.
- *                     Number of tagged-as-unused IDs is then set for each type, and as total in
- *                     #INDEX_ID_NULL item.
+ * \param r_num_tagged: If non-NULL, must be a zero-initialized array of #INDEX_ID_MAX integers.
+ * Number of tagged-as-unused IDs is then set for each type, and as total in
+ * #INDEX_ID_NULL item.
  */
 void BKE_lib_query_unused_ids_tag(Main *bmain,
                                   const int tag,
diff --git a/source/blender/blenkernel/intern/undo_system.c b/source/blender/blenkernel/intern/undo_system.c
index 0ca2b97b4ef..db5184edfd2 100644
--- a/source/blender/blenkernel/intern/undo_system.c
+++ b/source/blender/blenkernel/intern/undo_system.c
@@ -744,16 +744,15 @@ static UndoStep *undosys_step_iter_first(UndoStep *us_reference, const eUndoStep
 /**
  * Undo/Redo until the given `us_target` step becomes the active (currently loaded) one.
  *
- * \note Unless `us_target` is a 'skipped' one and `use_skip` is true, `us_target` will become the
- *       active step.
+ * \note Unless `us_target` is a 'skipped' one and `use_skip` is true, `us_target`
+ * will become the active step.
  *
- * \note In case `use_skip` is true, the final target will always be **beyond** the given one (if
- *       the given one has to be skipped).
+ * \note In case `use_skip` is true, the final target will always be **beyond** the given one
+ * (if the given one has to be skipped).
  *
- * \param us_reference If NULL, will be set to current active step in the undo stack. Otherwise, it
- *                     is assumed to match the current state, and will be used as basis for the
- *                     undo/redo process (i.e. all steps in-between `us_reference` and `us_target`
- *                     will be processed).
+ * \param us_reference: If NULL, will be set to current active step in the undo stack. Otherwise,
+ * it is assumed to match the current state, and will be used as basis for the undo/redo process
+ * (i.e. all steps in-between `us_reference` and `us_target` will be processed).
  */
 bool BKE_undosys_step_load_data_ex(UndoStack *ustack,
                                    bContext *C,
diff --git a/source/blender/blenlib/tests/BLI_color_test.cc b/source/blender/blenlib/tests/BLI_color_test.cc
index 14796e6bf71..a91c743b133 100644
--- a/source/blender/blenlib/tests/BLI_color_test.cc
+++ b/source/blender/blenlib/tests/BLI_color_test.cc
@@ -128,6 +128,6 @@ TEST(color, SceneLinearByteDecoding)
   EXPECT_NEAR(0.5f, decoded.a, 0.01f);
 }
 
-/* \} */
+/** \} */
 
 }  // namespace blender::tests
diff --git a/source/blender/compositor/intern/COM_WorkScheduler.cc b/source/blender/compositor/intern/COM_WorkScheduler.cc
index 8e49bf34b51..a08f9dd284c 100644
--- a/source/blender/compositor/intern/COM_WorkScheduler.cc
+++ b/source/blender/compositor/intern/COM_WorkScheduler.cc
@@ -298,7 +298,7 @@ static void opencl_deinitialize()
   g_work_scheduler.opencl.initialized = false;
 }
 
-/* \} */
+/** \} */
 
 /* -------------------------------------------------------------------- */
 /** \name Single threaded Scheduling
@@ -310,7 +310,7 @@ static void threading_model_single_thread_execute(WorkPackage *package)
   device.execute(package);
 }
 
-/* \} */
+/** \} */
 
 /* -------------------------------------------------------------------- */
 /** \name Queue Scheduling
@@ -388,7 +388,7 @@ static void threading_model_queue_deinitialize()
   }
 }
 
-/* \} */
+/** \} */
 
 /* -------------------------------------------------------------------- */
 /** \name Task Scheduling
@@ -426,7 +426,7 @@ static void threading_model_task_stop()
   BLI_thread_local_delete(g_thread_device);
 }
 
-/* \} */
+/** \} */
 
 /* -------------------------------------------------------------------- */
 /** \name Public API
@@ -587,6 +587,6 @@ int WorkScheduler::current_thread_id()
   return device->thread_id();
 }
 
-/* \} */
+/** \} */
 
 }  // namespace blender::compositor
diff --git a/source/blender/compositor/nodes/COM_CryptomatteNode.cc b/source/blender/compositor/nodes/COM_CryptomatteNode.cc
index 5835f051ce3..c04d98d6a2b 100644
--- a/source/blender/compositor/nodes/COM_CryptomatteNode.cc
+++ b/source/blender/compositor/nodes/COM_CryptomatteNode.cc
@@ -33,7 +33,8 @@
 
 namespace blender::compositor {
 
-/** \name Cryptomatte base
+/* -------------------------------------------------------------------- */
+/** \name Cryptomatte Base
  * \{ */
 
 void CryptomatteBaseNode::convertToOperations(NodeConverter &converter,
@@ -73,10 +74,12 @@ void CryptomatteBaseNode::convertToOperations(NodeConverter &converter,
   converter.mapOutputSocket(output_pick_socket, extract_pick_operation->getOutputSocket(0));
 }
 
-/* \} */
+/** \} */
 
+/* -------------------------------------------------------------------- */
 /** \name Cryptomatte V2
  * \{ */
+
 static std::string prefix_from_node(const CompositorContext &context, const bNode &node)
 {
   char prefix[MAX_NAME];
@@ -247,9 +250,10 @@ CryptomatteOperation *CryptomatteNode::create_cryptomatte_operation(
   return operation;
 }
 
-/* \} */
+/** \} */
 
-/** \name Cryptomatte legacy
+/* -------------------------------------------------------------------- */
+/** \name Cryptomatte Legacy
  * \{ */
 
 CryptomatteOperation *CryptomatteLegacyNode::create_cryptomatte_operation(
@@ -273,6 +277,6 @@ CryptomatteOperation *CryptomatteLegacyNode::create_cryptomatte_operation(
   return operation;
 }
 
-/* \} */
+/** \} */
 
 }  // namespace blender::compositor
diff --git a/source/blender/windowmanager/intern/wm_files_link.c b/source/blender/windowmanager/intern/wm_files_link.c
index 4affabb6da2..512320d3850 100644
--- a/source/blender/windowmanager/intern/wm_files_link.c
+++ b/source/blender/windowmanager/intern/wm_files_link.c
@@ -565,7 +565,7 @@ static void wm_append_loose_data_instantiate(WMLinkAppendData *lapp_data,
   }
 }
 
-/* \} */
+/** \} */
 
 static int foreach_libblock_append_callback(LibraryIDLinkCallbackData *cb_data)
 {