annotate libmlk-rpg/mlk/rpg/rpg.h @ 581:cedfdbc0e9a7

misc: update copyright years
author David Demelier <markand@malikania.fr>
date Sun, 12 Mar 2023 21:25:14 +0100
parents c32d7a98bde1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
156
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
543
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
2 * rpg.h -- libmlk-rpg main entry
156
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
445
773a082f0b91 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 434
diff changeset
4 * Copyright (c) 2020-2023 David Demelier <markand@malikania.fr>
156
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
19 #ifndef MLK_RPG_RPG_H
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
20 #define MLK_RPG_RPG_H
156
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
543
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
22 /**
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
23 * \file mlk/rpg/rpg.h
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
24 * \brief libmlk-rpg main entry
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
25 */
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
26
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
27 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
28 extern "C" {
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
29 #endif
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
30
543
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
31 /**
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
32 * Initialize the RPG library.
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
33 *
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
34 * \return 0 on success or any error code instead
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
35 */
298
196264679079 misc: remove usage of bool
David Demelier <markand@malikania.fr>
parents: 292
diff changeset
36 int
543
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
37 mlk_rpg_init(void);
156
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
543
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
39 /**
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
40 * Cleanup resources allocated by the library.
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
41 */
156
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 void
543
c32d7a98bde1 rpg: rpg -> mlk_rpg
David Demelier <markand@malikania.fr>
parents: 517
diff changeset
43 mlk_rpg_finish(void);
156
c3a40062acc2 misc: create more generic startup function, closes #2500
David Demelier <markand@malikania.fr>
parents:
diff changeset
44
517
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
45 #if defined(__cplusplus)
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
46 }
6e8f6640e05b misc: use extern C manually
David Demelier <markand@malikania.fr>
parents: 462
diff changeset
47 #endif
292
08ab73b32832 misc: add extern "C" {} blocks for C++ friends
David Demelier <markand@malikania.fr>
parents: 243
diff changeset
48
366
19782ea1cf4a misc: start rebranding
David Demelier <markand@malikania.fr>
parents: 320
diff changeset
49 #endif /* !MLK_RPG_H */