Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / BLI_math.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  *
19  * The Original Code is: some of this file.
20  *
21  * */
22
23 #ifndef __BLI_MATH_H__
24 #define __BLI_MATH_H__
25
26 /** \file \ingroup bli
27  *
28  * \section mathabbrev Abbreviations
29  *
30  * - ``fl`` = float
31  * - ``db`` = double
32  * - ``v2`` = vec2 = vector 2
33  * - ``v3`` = vec3 = vector 3
34  * - ``v4`` = vec4 = vector 4
35  * - ``vn`` = vec4 = vector N dimensions, *passed as an arg, after the vector*.
36  * - ``qt`` = quat = quaternion
37  * - ``dq`` = dquat = dual quaternion
38  * - ``m2`` = mat2 = matrix 2x2
39  * - ``m3`` = mat3 = matrix 3x3
40  * - ``m4`` = mat4 = matrix 4x4
41  * - ``eul`` = euler rotation
42  * - ``eulO`` = euler with order
43  * - ``plane`` = plane 4, (vec3, distance)
44  * - ``plane3`` = plane 3 (same as a ``plane`` with a zero 4th component)
45  *
46  * \subsection mathabbrev_all Function Type Abbreviations
47  *
48  * For non float versions of functions (which typically operate on floats),
49  * use single suffix abbreviations.
50  *
51  * - ``_d`` = double
52  * - ``_i`` = int
53  * - ``_u`` = unsigned int
54  * - ``_char`` = char
55  * - ``_uchar`` = unsigned char
56  *
57  * \section mathvarnames Variable Names
58  *
59  * - f = single value
60  * - a, b, c = vectors
61  * - r = result vector
62  * - A, B, C = matrices
63  * - R = result matrix
64  */
65
66 #include "BLI_math_base.h"
67 #include "BLI_math_color.h"
68 #include "BLI_math_matrix.h"
69 #include "BLI_math_rotation.h"
70 #include "BLI_math_vector.h"
71 #include "BLI_math_geom.h"
72 #include "BLI_math_interp.h"
73 #include "BLI_math_solvers.h"
74 #include "BLI_math_statistics.h"
75
76 #endif /* __BLI_MATH_H__ */