summaryrefslogtreecommitdiffhomepage
path: root/sample/include/sample.h
blob: 0fbae1ac9c9bca70100b0c3f6ca9a6d9a2c4a46f (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
#include "mruby.h"

#ifndef SAMPLE_H
#define SAMPLE_H

/**
 * Sample C API module definition
 */
MRB_BEGIN_DECL

/**
 * A Sample C API method definition
 *
 * @param mrb The MRuby state.
 * @return some ruby value
 */
MRB_API mrb_value sample_api_method(mrb_state *mrb);

/**
 * Another API method, now inlined.
 *
 * @param value some ruby value
 * @return the same value
 */
MRB_INLINE mrb_value sample_inline_method(mrb_value value)
{
	return value;
}

/**
 * A sample deprecated method
 */
MRB_API mrb_deprecated void sample_deprecated_method( void );

MRB_END_DECL

#endif /* SAMPLE_H */