[Bf-blender-cvs] [6fc6f2504df] master: Cleanup: use backslash for doxygen commands
Campbell Barton
noreply at git.blender.org
Thu Sep 5 04:58:17 CEST 2019
Commit: 6fc6f2504dfdae50c8184185222350052be0775c
Author: Campbell Barton
Date: Thu Sep 5 12:56:55 2019 +1000
Branches: master
https://developer.blender.org/rB6fc6f2504dfdae50c8184185222350052be0775c
Cleanup: use backslash for doxygen commands
===================================================================
M intern/memutil/MEM_RefCounted.h
M intern/utfconv/utfconv.h
M source/blender/blenlib/intern/listbase.c
M source/blender/blenlib/intern/math_rotation.c
M source/blender/draw/intern/draw_manager.c
===================================================================
diff --git a/intern/memutil/MEM_RefCounted.h b/intern/memutil/MEM_RefCounted.h
index 28b24d04586..42e595aadf4 100644
--- a/intern/memutil/MEM_RefCounted.h
+++ b/intern/memutil/MEM_RefCounted.h
@@ -34,8 +34,8 @@
* The default destructor of this object has been made protected on purpose.
* This disables the creation of shared objects on the stack.
*
- * @author Maarten Gribnau
- * @date March 31, 2001
+ * \author Maarten Gribnau
+ * \date March 31, 2001
*/
class MEM_RefCounted {
@@ -49,20 +49,20 @@ class MEM_RefCounted {
/**
* Returns the reference count of this object.
- * @return the reference count.
+ * \return the reference count.
*/
inline virtual int getRef() const;
/**
* Increases the reference count of this object.
- * @return the new reference count.
+ * \return the new reference count.
*/
inline virtual int incRef();
/**
* Decreases the reference count of this object.
* If the reference count reaches zero, the object self-destructs.
- * @return the new reference count.
+ * \return the new reference count.
*/
inline virtual int decRef();
diff --git a/intern/utfconv/utfconv.h b/intern/utfconv/utfconv.h
index befaeae63de..46c07500bf7 100644
--- a/intern/utfconv/utfconv.h
+++ b/intern/utfconv/utfconv.h
@@ -31,15 +31,15 @@ extern "C" {
/**
* Counts how many bytes is requered for for future utf-8 string using utf-16
- * @param string-16 pointer to working utf-16 string
- * @return How many bytes must be allocated includeng NULL.
+ * \param string16: pointer to working utf-16 string
+ * \return How many bytes must be allocated includeng NULL.
*/
size_t count_utf_8_from_16(const wchar_t *string16);
/**
* Counts how many wchar_t (two byte) is requered for for future utf-16 string using utf-8
- * @param string-8 pointer to working utf-8 string
- * @return How many bytes must be allocated includeng NULL.
+ * \param string8: pointer to working utf-8 string
+ * \return How many bytes must be allocated includeng NULL.
*/
size_t count_utf_16_from_8(const char *string8);
@@ -54,36 +54,36 @@ size_t count_utf_16_from_8(const char *string8);
/**
* Converts utf-16 string to allocated utf-8 string
- * @param in16 utf-16 string to convert
- * @param out8 utf-8 string to string the conversion
- * @param size8 the allocated size in bytes of out8
- * @return Returns any errors occured during conversion. See the block above,
+ * \param in16: utf-16 string to convert
+ * \param out8: utf-8 string to string the conversion
+ * \param size8: the allocated size in bytes of out8
+ * \return Returns any errors occured during conversion. See the block above,
*/
int conv_utf_16_to_8(const wchar_t *in16, char *out8, size_t size8);
/**
* Converts utf-8 string to allocated utf-16 string
- * @param in8 utf-8 string to convert
- * @param out16 utf-16 string to string the conversion
- * @param size16 the allocated size in wchar_t (two byte) of out16
- * @return Returns any errors occured during conversion. See the block above,
+ * \param in8: utf-8 string to convert
+ * \param out16: utf-16 string to string the conversion
+ * \param size16: the allocated size in wchar_t (two byte) of out16
+ * \return Returns any errors occured during conversion. See the block above,
*/
int conv_utf_8_to_16(const char *in8, wchar_t *out16, size_t size16);
/**
* Allocates and converts the utf-8 string from utf-16
- * @param in16 utf-16 string to convert
- * @param add any additional size which will be allocated for new utf-8 string in bytes
- * @return New allocated and converted utf-8 string or NULL if in16 is 0.
+ * \param in16: utf-16 string to convert
+ * \param add: any additional size which will be allocated for new utf-8 string in bytes
+ * \return New allocated and converted utf-8 string or NULL if in16 is 0.
*/
char *alloc_utf_8_from_16(const wchar_t *in16, size_t add);
/**
* Allocates and converts the utf-16 string from utf-8
- * @param in8 utf-8 string to convert
- * @param add any additional size which will be allocated for new utf-16 string
+ * \param in8: utf-8 string to convert
+ * \param add: any additional size which will be allocated for new utf-16 string
* in wchar_t (two bytes)
- * @return New allocated and converted utf-16 string or NULL if in8 is 0.
+ * \return New allocated and converted utf-16 string or NULL if in8 is 0.
*/
wchar_t *alloc_utf16_from_8(const char *in8, size_t add);
diff --git a/source/blender/blenlib/intern/listbase.c b/source/blender/blenlib/intern/listbase.c
index 631978f60fe..232dc245152 100644
--- a/source/blender/blenlib/intern/listbase.c
+++ b/source/blender/blenlib/intern/listbase.c
@@ -506,7 +506,7 @@ bool BLI_listbase_link_move(ListBase *listbase, void *vlink, int step)
/**
* Move the link at the index \a from to the position at index \a to.
*
- * @return If the move was successful.
+ * \return If the move was successful.
*/
bool BLI_listbase_move_index(ListBase *listbase, int from, int to)
{
diff --git a/source/blender/blenlib/intern/math_rotation.c b/source/blender/blenlib/intern/math_rotation.c
index 5762d164914..37c0c05b061 100644
--- a/source/blender/blenlib/intern/math_rotation.c
+++ b/source/blender/blenlib/intern/math_rotation.c
@@ -535,14 +535,15 @@ void rotation_between_quats_to_quat(float q[4], const float q1[4], const float q
mul_qt_qtqt(q, tquat, q2);
}
-/** Decompose a quaternion into a swing rotation (quaternion with the selected
- * axis component locked at zero), followed by a twist rotation around the axis.
+/**
+ * Decompose a quaternion into a swing rotation (quaternion with the selected
+ * axis component locked at zero), followed by a twist rotation around the axis.
*
- * \param q: input quaternion.
- * \param axis: twist axis in [0,1,2]
- * \param r_swing[out]: if not NULL, receives the swing quaternion.
- * \param r_twist[out]: if not NULL, receives the twist quaternion.
- * \returns twist angle.
+ * \param q: input quaternion.
+ * \param axis: twist axis in [0,1,2]
+ * \param r_swing[out]: if not NULL, receives the swing quaternion.
+ * \param r_twist[out]: if not NULL, receives the twist quaternion.
+ * \returns twist angle.
*/
float quat_split_swing_and_twist(const float q[4], int axis, float r_swing[4], float r_twist[4])
{
diff --git a/source/blender/draw/intern/draw_manager.c b/source/blender/draw/intern/draw_manager.c
index b64b6f9a788..6719bd7943f 100644
--- a/source/blender/draw/intern/draw_manager.c
+++ b/source/blender/draw/intern/draw_manager.c
@@ -1768,7 +1768,9 @@ void DRW_draw_render_loop(struct Depsgraph *depsgraph,
DRW_draw_render_loop_ex(depsgraph, engine_type, ar, v3d, viewport, NULL);
}
-/* @viewport CAN be NULL, in this case we create one. */
+/**
+ * \param viewport: can be NULL, in this case we create one.
+ */
void DRW_draw_render_loop_offscreen(struct Depsgraph *depsgraph,
RenderEngineType *engine_type,
ARegion *ar,
More information about the Bf-blender-cvs
mailing list