Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / BLI_blenlib.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
20 /** \file \ingroup bli
21  *
22  * \section aboutbli Blender LIbrary external interface
23  *
24  * \subsection about About the BLI module
25  *
26  * This is the external interface of the Blender Library. If you find
27  * a call to a BLI function that is not prototyped here, please add a
28  * prototype here. The library offers mathematical operations (mainly
29  * vector and matrix calculus), an abstraction layer for file i/o,
30  * functions for calculating Perlin noise, scanfilling services for
31  * triangles, and a system for guarded memory
32  * allocation/deallocation. There is also a patch to make MS Windows
33  * behave more or less Posix-compliant.
34  *
35  * \subsection issues Known issues with BLI
36  *
37  * - blenlib is written in C.
38  * - The posix-compliance may move to a separate lib that deals with
39  *   platform dependencies. (There are other platform-dependent
40  *   fixes as well.)
41  * - The file i/o has some redundant code. It should be cleaned.
42  *
43  * \subsection dependencies Dependencies
44  *
45  * - The blenlib uses type defines from \ref DNA, and functions from
46  * standard libraries.
47  */
48
49 #ifndef __BLI_BLENLIB_H__
50 #define __BLI_BLENLIB_H__
51
52
53 #include <stdlib.h>
54
55 #ifdef __cplusplus
56 extern "C" {
57 #endif
58
59 #include "BLI_listbase.h"
60
61 #include "BLI_string.h"
62
63 #include "BLI_string_utf8.h"
64
65 #include "BLI_path_util.h"
66
67 #include "BLI_fileops.h"
68
69 #include "BLI_rect.h"
70
71 #ifdef __cplusplus
72 }
73 #endif
74
75 #endif