Cleanup: doxygen comments

intern/libmv/libmv/multiview/homography.h

@@ -27,21 +27,23 @@ namespace libmv {
 
 /**
  * 2D homography transformation estimation.
- * 
+ *
  * This function estimates the homography transformation from a list of 2D
  * correspondences which represents either:
  *
  * - 3D points on a plane, with a general moving camera.
  * - 3D points with a rotating camera (pure rotation).
  * - 3D points + different planar projections
- * 
- * \param x1 The first 2xN or 3xN matrix of euclidean or homogeneous points.
- * \param x2 The second 2xN or 3xN matrix of euclidean or homogeneous points.
- * \param  H The 3x3 homography transformation matrix (8 dof) such that
- *               x2 = H * x1   with       |a b c| 
- *                                    H = |d e f|
- *                                        |g h 1| 
- * \param expected_precision The expected precision in order for instance 
+ *
+ * \param x1: The first 2xN or 3xN matrix of euclidean or homogeneous points.
+ * \param x2: The second 2xN or 3xN matrix of euclidean or homogeneous points.
+ * \param H: The 3x3 homography transformation matrix (8 dof) such that
+ * <pre>
+ * x2 = H * x1   with       |a b c|
+ *                      H = |d e f|
+ *                          |g h 1|
+ * </pre>
+ * \param expected_precision: The expected precision in order for instance
  *                           to accept almost homography matrices.
  *
  * \return True if the transformation estimation has succeeded.
@@ -113,16 +115,18 @@ bool EstimateHomography2DFromCorrespondences(
  * \param[in] x1 The first 4xN matrix of homogeneous points
  * \param[in] x2 The second 4xN matrix of homogeneous points
  * \param[out] H The 4x4 homography transformation matrix (15 dof) such that
- *               x2 = H * x1   with       |a b c d| 
- *                                    H = |e f g h|
- *                                        |i j k l|
- *                                        |m n o 1| 
- * \param[in] expected_precision The expected precision in order for instance 
+ * <pre>
+ * x2 = H * x1   with       |a b c d|
+ *                      H = |e f g h|
+ *                          |i j k l|
+ *                          |m n o 1|
+ * </pre>
+ * \param[in] expected_precision The expected precision in order for instance
  *        to accept almost homography matrices.
  *
  * \return true if the transformation estimation has succeeded
  *
- * \note Need at least 5 non coplanar points 
+ * \note Need at least 5 non coplanar points
  * \note Points coordinates must be in homogeneous coordinates
  */
 bool Homography3DFromCorrespondencesLinear(const Mat &x1,

intern/libmv/libmv/simple_pipeline/keyframe_selection.h

@@ -38,11 +38,11 @@ namespace libmv {
 // and if expected error estimation is too large, keyframe candidate
 // is rejecting.
 //
-// \param tracks contains all tracked correspondences between frames
-//        expected to be undistorted and normalized
-// \param intrinsics is camera intrinsics
-// \param keyframes will contain all images number which are considered
-//        good to be used for reconstruction
+// \param tracks: contains all tracked correspondences between frames
+//        expected to be undistorted and normalized.
+// \param intrinsics: is camera intrinsics.
+// \param keyframes: will contain all images number which are considered
+//        good to be used for reconstruction.
 void SelectKeyframesBasedOnGRICAndVariance(
     const Tracks &tracks,
     const CameraIntrinsics &intrinsics,

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,

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,

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,

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);
 

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);