[Bf-blender-cvs] [4412cbc6d19] master: Cleanup: Make RNA function comment more readable

[Julian Eisel]

Commit: 4412cbc6d1912cb40194c81b463f52587ca5d5eb
Author: Julian Eisel
Date:   Thu Apr 28 16:01:10 2022 +0200
Branches: master
https://developer.blender.org/rB4412cbc6d1912cb40194c81b463f52587ca5d5eb

Cleanup: Make RNA function comment more readable

This complex comment was hard to parse visually.
There was some odd line breaking going on, and together with no
indentation for the continued lines, it was just a blob of text with no
visual structure. You wouldn't see easily where the description of an
argument started or ended.

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

M	source/blender/makesrna/intern/rna_access.c

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

diff --git a/source/blender/makesrna/intern/rna_access.c b/source/blender/makesrna/intern/rna_access.c
index 5690d864a75..91bee19481c 100644
--- a/source/blender/makesrna/intern/rna_access.c
+++ b/source/blender/makesrna/intern/rna_access.c
@@ -5093,15 +5093,16 @@ static bool rna_path_parse_array_index(const char **path,
  * \param r_ptr: The final RNA data holding the last property in \a path.
  * \param r_prop: The final property of \a r_ptr, from \a path.
  * \param r_index: The final index in the \a r_prop, if defined by \a path.
- * \param r_item_ptr: Only valid for Pointer and Collection,
- * return the actual value of the pointer, or of the collection item.
- * Mutually exclusive with \a eval_pointer option.
- * \param r_elements: A list of \a PropertyElemRNA items
- * (pairs of \a PointerRNA, \a PropertyRNA that represent the whole given \a path).
- * \param eval_pointer: If \a true, and \a path leads to a Pointer property,
- * or an item in a Collection property,
- * \a r_ptr will be set to the value of that property, and \a r_prop will be NULL.
- * Mutually exclusive with \a r_item_ptr.
+ * \param r_item_ptr: Only valid for Pointer and Collection, return the actual value of the
+ *                    pointer, or of the collection item.
+ *                    Mutually exclusive with \a eval_pointer option.
+ * \param r_elements: A list of \a PropertyElemRNA items(pairs of \a PointerRNA, \a PropertyRNA
+ *                    that represent the whole given \a path).
+ * \param eval_pointer: If \a true, and \a path leads to a Pointer property, or an item in a
+ *                      Collection property, \a r_ptr will be set to the value of that property,
+ *                      and \a r_prop will be NULL.
+ *                      Mutually exclusive with \a r_item_ptr.
+ *
  * \return \a true on success, \a false if the path is somehow invalid.
  */
 static bool rna_path_parse(PointerRNA *ptr,