summaryrefslogtreecommitdiffstats
path: root/src/include/edoors_link.h
blob: e0dc5fd498b8df01cbd9511510e7800c4ae38585 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/* EDOORS
 * Copyright (C) 2012 Jérémy Zurcher
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library;
 * if not, see <http://www.gnu.org/licenses/>.
 */

#ifndef __EDOORS_LINK_H__
#define __EDOORS_LINK_H__

/**
 * @typedef Edoors_Link
 * Type for a Link between @ref Edoors_Iota.
 */
typedef struct _Edoors_Link Edoors_Link;

/**
 * @struct _Edoors_Link
 * Struct for a Link between @ref Edoors_Iota.
 */
struct _Edoors_Link {
};

/**
 * @defgroup Edoors_Link Edoors_Link
 *
 * A Edoors_Link allows to apply a destination list to a @ref Edoors_Particle with no defined destination.
 *
 * @{
 */

/**
 * @brief Free allocated resources.
 *
 * @param link The @ref Edoors_Link to free.
 */
void edoors_link_free(Edoors_Link *link);

/**
 * @}
 */

#endif // __EDOORS_LINK_H__