archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

Cleanup: doxygen comments

Browse Source 
Also remove duplicate & mismatching comments from grease-pencil header.
Keep comments close to implementation to avoid getting out of sync.
This commit is contained in:
Campbell Barton
2017-06-19 09:33:23 +10:00
parent 3190eaf109
commit 72c9141a7a
22 changed files with 130 additions and 165 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
source/blender/blenlib/intern/math_matrix.c
View File

@@ -1738,16 +1738,16 @@ void blend_m4_m4m4(float out[4][4], float dst[4][4], float src[4][4], const floa
/**
* A polar-decomposition-based interpolation between matrix A and matrix B.
*
* \note This code is about five times slower as the 'naive' interpolation done by \a blend_m3_m3m3
* (it typically remains below 2 usec on an average i74700, while \a blend_m3_m3m3 remains below 0.4 usec).
* \note This code is about five times slower as the 'naive' interpolation done by #blend_m3_m3m3
* (it typically remains below 2 usec on an average i74700, while #blend_m3_m3m3 remains below 0.4 usec).
* However, it gives expected results even with non-uniformaly scaled matrices, see T46418 for an example.
*
* Based on "Matrix Animation and Polar Decomposition", by Ken Shoemake & Tom Duff
*
* @return R the interpolated matrix.
* @param A the intput matrix which is totally effective with \a t = 0.0.
* @param B the intput matrix which is totally effective with \a t = 1.0.
* @param t the interpolation factor.
* \param R: Resulting interpolated matrix.
* \param A: Input matrix which is totally effective with `t = 0.0`.
* \param B: Input matrix which is totally effective with `t = 1.0`.
* \param t: Interpolation factor.
*/
void interp_m3_m3m3(float R[3][3], float A[3][3], float B[3][3], const float t)
{
@@ -1777,12 +1777,12 @@ void interp_m3_m3m3(float R[3][3], float A[3][3], float B[3][3], const float t)
}
/**
* Complete transform matrix interpolation, based on polar-decomposition-based interpolation from interp_m3_m3m3.
* Complete transform matrix interpolation, based on polar-decomposition-based interpolation from #interp_m3_m3m3.
*
* @return R the interpolated matrix.
* @param A the intput matrix which is totally effective with \a t = 0.0.
* @param B the intput matrix which is totally effective with \a t = 1.0.
* @param t the interpolation factor.
* \param R: Resulting interpolated matrix.
* \param A: Input matrix which is totally effective with `t = 0.0`.
* \param B: Input matrix which is totally effective with `t = 1.0`.
* \param t: Interpolation factor.
*/
void interp_m4_m4m4(float R[4][4], float A[4][4], float B[4][4], const float t)
{