From 605425c0063f2e357df5a00056c2ca3439e46533 Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Fri, 6 Nov 2020 14:35:38 +1100
Subject: Cleanup: doxygen comments

---
 source/blender/blenkernel/intern/gpencil.c             | 12 ++++++------
 source/blender/blenlib/intern/math_geom.c              |  2 +-
 source/blender/editors/gpencil/gpencil_utils.c         |  4 ++--
 source/blender/freestyle/intern/geometry/matrix_util.h | 14 ++++++++------
 source/blender/gpu/opengl/gl_framebuffer.hh            | 10 +++++-----
 5 files changed, 22 insertions(+), 20 deletions(-)

(limited to 'source')

diff --git a/source/blender/blenkernel/intern/gpencil.c b/source/blender/blenkernel/intern/gpencil.c
index 1dacd442e81..4cf8e365cf6 100644
--- a/source/blender/blenkernel/intern/gpencil.c
+++ b/source/blender/blenkernel/intern/gpencil.c
@@ -2011,12 +2011,12 @@ void BKE_gpencil_material_remap(struct bGPdata *gpd,
 
 /**
  * Load a table with material conversion index for merged materials.
- * \param ob: Grease pencil object
- * \param hue_threshold: Threshold for Hue
- * \param sat_threshold: Threshold for Saturation
- * \param val_threshold: Threshold for Value
- * \param r_mat_table : return material table
- * \return True if done
+ * \param ob: Grease pencil object.
+ * \param hue_threshold: Threshold for Hue.
+ * \param sat_threshold: Threshold for Saturation.
+ * \param val_threshold: Threshold for Value.
+ * \param r_mat_table: return material table.
+ * \return True if done.
  */
 bool BKE_gpencil_merge_materials_table_get(Object *ob,
                                            const float hue_threshold,
diff --git a/source/blender/blenlib/intern/math_geom.c b/source/blender/blenlib/intern/math_geom.c
index c834108a0de..1d2480f4d62 100644
--- a/source/blender/blenlib/intern/math_geom.c
+++ b/source/blender/blenlib/intern/math_geom.c
@@ -1418,7 +1418,7 @@ int isect_seg_seg_v2_lambda_mu_db(const double v1[2],
 
 /**
  * \param l1, l2: Coordinates (point of line).
- * \param sp, r:  Coordinate and radius (sphere).
+ * \param sp, r: Coordinate and radius (sphere).
  * \return r_p1, r_p2: Intersection coordinates.
  *
  * \note The order of assignment for intersection points (\a r_p1, \a r_p2) is predictable,
diff --git a/source/blender/editors/gpencil/gpencil_utils.c b/source/blender/editors/gpencil/gpencil_utils.c
index 3e16980c651..0fdd70c55bc 100644
--- a/source/blender/editors/gpencil/gpencil_utils.c
+++ b/source/blender/editors/gpencil/gpencil_utils.c
@@ -2982,8 +2982,8 @@ bool ED_gpencil_stroke_check_collision(GP_SpaceConversion *gsc,
  *
  * \param gps: Stroke to check.
  * \param gsc: Space conversion data.
- * \param mouse:  Mouse position.
- * \param diff_mat:  View matrix.
+ * \param mouse: Mouse position.
+ * \param diff_mat: View matrix.
  * \return True if the point is inside.
  */
 bool ED_gpencil_stroke_point_is_inside(bGPDstroke *gps,
diff --git a/source/blender/freestyle/intern/geometry/matrix_util.h b/source/blender/freestyle/intern/geometry/matrix_util.h
index 996ebc928a1..8a20cb31300 100644
--- a/source/blender/freestyle/intern/geometry/matrix_util.h
+++ b/source/blender/freestyle/intern/geometry/matrix_util.h
@@ -42,16 +42,18 @@ namespace MatrixUtil {
 /**
  * computes the eigen values and eigen vectors of a semi definite symmetric matrix
  *
- * \param  mat: The matrix stored in column symmetric storage, i.e.
- *     matrix = { m11, m12, m22, m13, m23, m33, m14, m24, m34, m44 ... }
- *     size = n(n+1)/2
+ * \param mat: The matrix stored in column symmetric storage, i.e.
+ * <pre>
+ * matrix = { m11, m12, m22, m13, m23, m33, m14, m24, m34, m44 ... }
+ * size = n(n+1)/2
+ * </pre>
  *
  * \param eigen_vec: (return) = { v1, v2, v3, ..., vn }
- *   where vk = vk0, vk1, ..., vkn
- *     size = n^2, must be allocated by caller
+ *   where `vk = vk0, vk1, ..., vkn`
+ *     `size = n^2`, must be allocated by caller.
  *
  * \param eigen_val: (return) are in decreasing order
- *     size = n,   must be allocated by caller
+ *     `size = n`,   must be allocated by caller.
  */
 void semi_definite_symmetric_eigen(const double *mat, int n, double *eigen_vec, double *eigen_val);
 
diff --git a/source/blender/gpu/opengl/gl_framebuffer.hh b/source/blender/gpu/opengl/gl_framebuffer.hh
index cf159a60b01..1de366fc844 100644
--- a/source/blender/gpu/opengl/gl_framebuffer.hh
+++ b/source/blender/gpu/opengl/gl_framebuffer.hh
@@ -67,11 +67,11 @@ class GLFrameBuffer : public FrameBuffer {
   /**
    * Special frame-buffer encapsulating internal window frame-buffer.
    *  (i.e.: #GL_FRONT_LEFT, #GL_BACK_RIGHT, ...)
-   * \param ctx:    context the handle is from.
-   * \param target: the internal GL name (i.e: #GL_BACK_LEFT).
-   * \param fbo:    the (optional) already created object for some implementation. Default is 0.
-   * \param w:      buffer width.
-   * \param h:      buffer height.
+   * \param ctx: Context the handle is from.
+   * \param target: The internal GL name (i.e: #GL_BACK_LEFT).
+   * \param fbo: The (optional) already created object for some implementation. Default is 0.
+   * \param w: Buffer width.
+   * \param h: Buffer height.
    **/
   GLFrameBuffer(const char *name, GLContext *ctx, GLenum target, GLuint fbo, int w, int h);
 
-- 
cgit v1.2.3