diff options
| author | Seba Gamboa <[email protected]> | 2015-09-22 17:50:26 -0300 |
|---|---|---|
| committer | Seba Gamboa <[email protected]> | 2015-09-22 17:50:26 -0300 |
| commit | 2fb5a297afb868dbe7bbd54526c7bc11819c41cd (patch) | |
| tree | cabc656c05660dc01afc67018cc9be8501b44cd0 /sample/include | |
| parent | 80ab1e961810a6b571517ac9625e998194fbd57b (diff) | |
| download | yard-mruby-2fb5a297afb868dbe7bbd54526c7bc11819c41cd.tar.gz yard-mruby-2fb5a297afb868dbe7bbd54526c7bc11819c41cd.zip | |
Add sample gem project to test documentation generation
Diffstat (limited to 'sample/include')
| -rw-r--r-- | sample/include/sample.h | 37 |
1 files changed, 37 insertions, 0 deletions
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 */ |
