diff options
| author | Yukihiro "Matz" Matsumoto <[email protected]> | 2019-08-26 07:46:57 +0900 |
|---|---|---|
| committer | GitHub <[email protected]> | 2019-08-26 07:46:57 +0900 |
| commit | 2d09fd2135e4fb9230a62e2af1ff28d450f3184a (patch) | |
| tree | 644a637d60bfc1c7cd2fd2bb657a08bf5dc397b5 /README.md | |
| parent | a4870a579f483b30e547f6ed5d105179be222e53 (diff) | |
| parent | 6375639917a913c542967b33be01003a2b67c144 (diff) | |
| download | mruby-2d09fd2135e4fb9230a62e2af1ff28d450f3184a.tar.gz mruby-2d09fd2135e4fb9230a62e2af1ff28d450f3184a.zip | |
Merge pull request #4669 from davidsiaw/doxygen
Fixes for Doxygen docs
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 13 |
1 files changed, 13 insertions, 0 deletions
@@ -50,6 +50,19 @@ Or $ ruby ./minirake test +## Building documentation + +There are two sets of documentation in mruby: the mruby API (generated by yard) and C API (Doxygen) + +To build both of them, simply go + + rake doc + +You can also view them in your browser + + rake view_api + rake view_capi + ## How to customize mruby (mrbgems) mruby contains a package manager called *mrbgems*. To create extensions |