diff options
| author | take_cheeze <[email protected]> | 2014-06-23 21:24:10 +0900 |
|---|---|---|
| committer | take_cheeze <[email protected]> | 2014-06-23 21:55:54 +0900 |
| commit | ae15f264bd1cff6f8fb60704306106209e8c9d7c (patch) | |
| tree | 6ddb135274e0e33809e54e5699f40adb4e1baf11 /doc/api/README.md | |
| parent | c938b2f65647aae87a7bcfeb3a9462b90aaa0ce4 (diff) | |
| download | mruby-ae15f264bd1cff6f8fb60704306106209e8c9d7c.tar.gz mruby-ae15f264bd1cff6f8fb60704306106209e8c9d7c.zip | |
Start documenting C APIs.
Diffstat (limited to 'doc/api/README.md')
| -rw-r--r-- | doc/api/README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/doc/api/README.md b/doc/api/README.md new file mode 100644 index 000000000..131e50515 --- /dev/null +++ b/doc/api/README.md @@ -0,0 +1,30 @@ +# C API Reference + +This is a C API Reference. +The structure of this document will follow the directory structure of `include/` directory. + +## Headers list +Header name|Features +-----------|-------- +[mrbconf.h](../mrbconf/README.md)|Defines macros for mruby configurations. +[mruby.h](./mruby.h.md)|Main header of mruby C API. Include this first. +[mruby/array.h](./mruby.array.h.md)|`Array` class. +[mruby/class.h](./mruby.class.h.md)|`Class` class. +[mruby/compile.h](./mruby.compile.h.md)|mruby compiler. +[mruby/data.h](./mruby.data.h.md)|User defined object. +[mruby/debug.h](./mruby.debug.h.md)|Debugging. +[mruby/dump.h](./mruby.dump.h.md)|Dumping compiled mruby script. +[mruby/error.h](./mruby.error.h.md)|Error handling. +[mruby/gc.h](./mruby.gc.h.md)|Uncommon memory management stuffs. +[mruby/hash.h](./mruby.hash.h.md)|`Hash` class. +[mruby/irep.h](./mruby.irep.h.md)|Compiled mruby script. +[mruby/khash.h](./mruby.khash.h.md)|Defines of khash which is used in hash table of mruby. +[mruby/numeric.h](./mruby.numeric.h.md)|`Numeric` class and sub-classes of it. +[mruby/opode.h](./mruby.opcode.h.md)|Operation codes used in mruby VM. +[mruby/proc.h](./mruby.proc.h.md)|`Proc` class. +[mruby/range.h](./mruby.range.h.md)|`Range` class. +[mruby/re.h](./mruby.re.h.md)|`Regexp` class. +[mruby/string.h](./mruby.string.h.md)|`String` class. +[mruby/value.h](./mruby.value.h.md)|`mrb_value` functions and macros. +[mruby/variable.h](./mruby.variable.h.md)|Functions to access to mruby variables. +[mruby/version.h](./mruby.version.h.md)|Macros of mruby version. |
