Cleanup: remove redundant doxygen \file argument
[blender.git] / source / blender / blenlib / BLI_console.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) 2018 Blender Foundation.
17  * All rights reserved.
18  */
19
20 #ifndef __BLI_CONSOLE_H__
21 #define __BLI_CONSOLE_H__
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 /** \file \ingroup bli
28  *  \brief Set of utility functions and constants to work with consoles.
29  */
30
31 /* Format string where one could BLI_snprintf() R, G and B values
32  * and get proper marker to start colored output in the console.
33  */
34 #define TRUECOLOR_ANSI_COLOR_FORMAT "\x1b[38;2;%d;%d;%dm"
35
36 /* Marker which indicates that colored output is finished. */
37 #define TRUECOLOR_ANSI_COLOR_FINISH "\x1b[0m"
38
39 #ifdef __cplusplus
40 }
41 #endif
42
43 #endif  /* __BLI_CONSOLE_H__ */