doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / BKE_idcode.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 #ifndef __BKE_IDCODE_H__
21 #define __BKE_IDCODE_H__
22
23 /** \file
24  * \ingroup bke
25  */
26
27 const char *BKE_idcode_to_name(short idcode);
28 const char *BKE_idcode_to_name_plural(short idcode);
29 const char *BKE_idcode_to_translation_context(short idcode);
30 short       BKE_idcode_from_name(const char *name);
31 bool        BKE_idcode_is_linkable(short idcode);
32 bool        BKE_idcode_is_valid(short idcode);
33
34 int         BKE_idcode_to_idfilter(const short idcode);
35 short       BKE_idcode_from_idfilter(const int idfilter);
36
37 int BKE_idcode_to_index(const short idcode);
38 short BKE_idcode_from_index(const int index);
39
40 short BKE_idcode_iter_step(int *index);
41
42 #endif