[Bf-blender-cvs] [262ef26ea3f] master: Cleanup: use colon after doxygen params, correct slash direction

Campbell Barton noreply at git.blender.org
Tue Nov 30 00:18:14 CET 2021


Commit: 262ef26ea3fe457ff077224662eaecc1b912aed1
Author: Campbell Barton
Date:   Tue Nov 30 08:53:33 2021 +1100
Branches: master
https://developer.blender.org/rB262ef26ea3fe457ff077224662eaecc1b912aed1

Cleanup: use colon after doxygen params, correct slash direction

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

M	source/blender/blenkernel/intern/blendfile_link_append.c
M	source/blender/blenkernel/intern/lib_id.c
M	source/blender/blenloader/intern/versioning_common.cc
M	source/blender/editors/animation/keyframes_general.c
M	source/blender/editors/asset/intern/asset_indexer.cc
M	source/blender/editors/asset/intern/asset_library_reference_enum.cc
M	source/blender/modifiers/intern/MOD_nodes_evaluator.cc

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

diff --git a/source/blender/blenkernel/intern/blendfile_link_append.c b/source/blender/blenkernel/intern/blendfile_link_append.c
index a0daa56f53a..fb961dba482 100644
--- a/source/blender/blenkernel/intern/blendfile_link_append.c
+++ b/source/blender/blenkernel/intern/blendfile_link_append.c
@@ -188,7 +188,7 @@ static void link_append_context_library_blohandle_release(
 
 /** Allocate and initialize a new context to link/append datablocks.
  *
- *  \param flag a combination of #eFileSel_Params_Flag from DNA_space_types.h & #eBLOLibLinkFlags
+ *  \param flag: A combination of #eFileSel_Params_Flag from DNA_space_types.h & #eBLOLibLinkFlags
  * from BLO_readfile.h
  */
 BlendfileLinkAppendContext *BKE_blendfile_link_append_context_new(LibraryLink_Params *params)
@@ -222,7 +222,7 @@ void BKE_blendfile_link_append_context_free(BlendfileLinkAppendContext *lapp_con
 
 /** Set or clear flags in given \a lapp_context.
  *
- * \param do_set Set the given \a flag if true, clear it otherwise.
+ * \param do_set: Set the given \a flag if true, clear it otherwise.
  */
 void BKE_blendfile_link_append_context_flag_set(BlendfileLinkAppendContext *lapp_context,
                                                 const int flag,
diff --git a/source/blender/blenkernel/intern/lib_id.c b/source/blender/blenkernel/intern/lib_id.c
index d41e81a07b5..58c909d0cd6 100644
--- a/source/blender/blenkernel/intern/lib_id.c
+++ b/source/blender/blenkernel/intern/lib_id.c
@@ -194,7 +194,7 @@ static int lib_id_clear_library_data_users_update_cb(LibraryIDLinkCallbackData *
  * Pull an ID out of a library (make it local). Only call this for IDs that
  * don't have other library users.
  *
- * \param flags Same set of `LIB_ID_MAKELOCAL_` flags as passed to `BKE_lib_id_make_local`.
+ * \param flags: Same set of `LIB_ID_MAKELOCAL_` flags as passed to `BKE_lib_id_make_local`.
  */
 void BKE_lib_id_clear_library_data(Main *bmain, ID *id, const int flags)
 {
diff --git a/source/blender/blenloader/intern/versioning_common.cc b/source/blender/blenloader/intern/versioning_common.cc
index af765be619f..ef275c56891 100644
--- a/source/blender/blenloader/intern/versioning_common.cc
+++ b/source/blender/blenloader/intern/versioning_common.cc
@@ -188,13 +188,13 @@ void version_node_id(bNodeTree *ntree, const int node_type, const char *new_name
  *
  * Since this is about animation data, it only concerns input sockets.
  *
- * \param node_tree_type node tree type that has these nodes, for example NTREE_SHADER.
- * \param node_type node type to adjust, for example SH_NODE_BSDF_PRINCIPLED.
- * \param socket_index_orig the original index of the moved socket; when socket 4 moved to 6,
+ * \param node_tree_type: Node tree type that has these nodes, for example #NTREE_SHADER.
+ * \param node_type: Node type to adjust, for example #SH_NODE_BSDF_PRINCIPLED.
+ * \param socket_index_orig: The original index of the moved socket; when socket 4 moved to 6,
  * pass 4 here.
- * \param socket_index_offset the offset of the nodes, so when socket 4 moved to 6,
+ * \param socket_index_offset: The offset of the nodes, so when socket 4 moved to 6,
  * pass 2 here.
- * \param total_number_of_sockets the total number of sockets in the node.
+ * \param total_number_of_sockets: The total number of sockets in the node.
  */
 void version_node_socket_index_animdata(Main *bmain,
                                         const int node_tree_type,
diff --git a/source/blender/editors/animation/keyframes_general.c b/source/blender/editors/animation/keyframes_general.c
index 6a0122f4dc4..03862405e75 100644
--- a/source/blender/editors/animation/keyframes_general.c
+++ b/source/blender/editors/animation/keyframes_general.c
@@ -320,8 +320,8 @@ void clean_fcurve(struct bAnimContext *ac, bAnimListElem *ale, float thresh, boo
 
 /** Find the first segment of consecutive selected curve points, starting from \a start_index.
  * Keys that have BEZT_FLAG_IGNORE_TAG set are treated as unselected.
- * \param r_segment_start_idx returns the start index of the segment.
- * \param r_segment_len returns the number of curve points in the segment.
+ * \param r_segment_start_idx: returns the start index of the segment.
+ * \param r_segment_len: returns the number of curve points in the segment.
  * \return whether such a segment was found or not.*/
 static bool find_fcurve_segment(FCurve *fcu,
                                 const int start_index,
diff --git a/source/blender/editors/asset/intern/asset_indexer.cc b/source/blender/editors/asset/intern/asset_indexer.cc
index 52b5df14c9f..43951b4b714 100644
--- a/source/blender/editors/asset/intern/asset_indexer.cc
+++ b/source/blender/editors/asset/intern/asset_indexer.cc
@@ -509,12 +509,12 @@ struct AssetLibraryIndex {
 /**
  * Instance of this class represents the contents of an asset index file.
  *
- * /code
+ * \code
  * {
  *    "version": {version},
  *    "entries": ...
  * }
- * /endcode
+ * \endcode
  */
 struct AssetIndex {
   /**
diff --git a/source/blender/editors/asset/intern/asset_library_reference_enum.cc b/source/blender/editors/asset/intern/asset_library_reference_enum.cc
index 102b2a97859..2ea01ecd343 100644
--- a/source/blender/editors/asset/intern/asset_library_reference_enum.cc
+++ b/source/blender/editors/asset/intern/asset_library_reference_enum.cc
@@ -99,7 +99,7 @@ AssetLibraryReference ED_asset_library_reference_from_enum_value(int value)
  * Since this is meant for UI display, skips non-displayable libraries, that is, libraries with an
  * empty name or path.
  *
- * \param include_local_library whether to include the "Current File" library or not.
+ * \param include_local_library: Whether to include the "Current File" library or not.
  */
 const EnumPropertyItem *ED_asset_library_reference_to_rna_enum_itemf(
     const bool include_local_library)
diff --git a/source/blender/modifiers/intern/MOD_nodes_evaluator.cc b/source/blender/modifiers/intern/MOD_nodes_evaluator.cc
index 77c680e82b1..dee9329e21b 100644
--- a/source/blender/modifiers/intern/MOD_nodes_evaluator.cc
+++ b/source/blender/modifiers/intern/MOD_nodes_evaluator.cc
@@ -1528,8 +1528,8 @@ class GeometryNodesEvaluator {
    * still be linked to e.g. a Group Input node, but the socket on the outside is not connected to
    * anything.
    *
-   * \param input_socket The socket of the node that wants to use the value.
-   * \param origin_socket The socket that we want to load the value from.
+   * \param input_socket: The socket of the node that wants to use the value.
+   * \param origin_socket: The socket that we want to load the value from.
    */
   void load_unlinked_input_value(LockedNode &locked_node,
                                  const DInputSocket input_socket,



More information about the Bf-blender-cvs mailing list