diff options
| author | Yukihiro "Matz" Matsumoto <[email protected]> | 2015-10-09 05:30:31 +0900 |
|---|---|---|
| committer | Yukihiro "Matz" Matsumoto <[email protected]> | 2015-10-09 05:30:31 +0900 |
| commit | 02a6d866bafc31efa0d583524f38232b848f0e58 (patch) | |
| tree | 869a2d8d13e3cf4070da9d10d571e4d08a8a9984 /doc/api/README.md | |
| parent | 0050bfe586fc9e7aa51d922a4cadcced52e3d80c (diff) | |
| parent | 87e0840e9d8894d491e5180c7f7923a5cc403f5d (diff) | |
| download | mruby-02a6d866bafc31efa0d583524f38232b848f0e58.tar.gz mruby-02a6d866bafc31efa0d583524f38232b848f0e58.zip | |
Merge pull request #2984 from sagmor/yard
Simpler documentation
Diffstat (limited to 'doc/api/README.md')
| -rw-r--r-- | doc/api/README.md | 30 |
1 files changed, 0 insertions, 30 deletions
diff --git a/doc/api/README.md b/doc/api/README.md deleted file mode 100644 index a83330d82..000000000 --- a/doc/api/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# 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. |
