diff options
author | Campbell Barton <ideasman42@gmail.com> | 2020-11-06 06:35:38 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2020-11-06 06:35:38 +0300 |
commit | 605425c0063f2e357df5a00056c2ca3439e46533 (patch) | |
tree | 33f3e57300ab54877984758c9675ddc6c4ef378a /source/blender/freestyle | |
parent | eed6bf22a4f74136cd10159ea32b788ae93d7850 (diff) |
Cleanup: doxygen comments
Diffstat (limited to 'source/blender/freestyle')
-rw-r--r-- | source/blender/freestyle/intern/geometry/matrix_util.h | 14 |
1 files changed, 8 insertions, 6 deletions
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); |