From 2fb5a297afb868dbe7bbd54526c7bc11819c41cd Mon Sep 17 00:00:00 2001 From: Seba Gamboa Date: Tue, 22 Sep 2015 17:50:26 -0300 Subject: Add sample gem project to test documentation generation --- sample/include/sample.h | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 sample/include/sample.h (limited to 'sample/include/sample.h') diff --git a/sample/include/sample.h b/sample/include/sample.h new file mode 100644 index 0000000..0fbae1a --- /dev/null +++ b/sample/include/sample.h @@ -0,0 +1,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 */ -- cgit v1.2.3