From 8d70a9b1b547e6ae4dffe4e604a614fc6d5a1fb4 Mon Sep 17 00:00:00 2001
From: David Siaw <davidsiaw@gmail.com>
Date: Sun, 18 Aug 2019 12:12:38 +0900
Subject: first bit of doc generation

---
 include/mruby/object.h | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

(limited to 'include')

diff --git a/include/mruby/object.h b/include/mruby/object.h
index 373e3bec7..1589e4c68 100644
--- a/include/mruby/object.h
+++ b/include/mruby/object.h
@@ -8,11 +8,11 @@
 #define MRUBY_OBJECT_H
 
 #define MRB_OBJECT_HEADER \
-  enum mrb_vtype tt:8;\
-  uint32_t color:3;\
-  uint32_t flags:21;\
-  struct RClass *c;\
-  struct RBasic *gcnext
+  enum mrb_vtype tt:8;   \
+  uint32_t color:3;      \
+  uint32_t flags:21;     \
+  struct RClass *c;      \
+  struct RBasic *gcnext  \
 
 #define MRB_FLAG_TEST(obj, flag) ((obj)->flags & (flag))
 
-- 
cgit v1.2.3


From 2c868954684e9e83c8b84ce0747bbb3e928d3143 Mon Sep 17 00:00:00 2001
From: David Siaw <davidsiaw@gmail.com>
Date: Sun, 18 Aug 2019 13:59:29 +0900
Subject: fix up markdown display in doxygen

---
 Makefile.doc           |  3 +-
 doc/guides/compile.md  | 80 +++++++++++++++++++++++++-------------------------
 doc/limitations.md     | 50 +++++++++++++++----------------
 doc/opcode.md          |  2 ++
 include/mruby/object.h | 11 ++++---
 5 files changed, 74 insertions(+), 72 deletions(-)

(limited to 'include')

diff --git a/Makefile.doc b/Makefile.doc
index 1d13b1884..cf95c187f 100644
--- a/Makefile.doc
+++ b/Makefile.doc
@@ -1,7 +1,8 @@
 SRCS=$(shell find src -name '*.c')
 HEADERS=$(shell find include -name '*.h')
+MDDOCS=$(shell find doc -name '*.md')
 
-doxygen : Doxyfile $(SRCS) $(HEADERS)
+doxygen : Doxyfile $(SRCS) $(HEADERS) $(MDDOCS)
 	doxygen Doxyfile
 
 docs : doxygen
diff --git a/doc/guides/compile.md b/doc/guides/compile.md
index 4c8378946..6a093310a 100644
--- a/doc/guides/compile.md
+++ b/doc/guides/compile.md
@@ -6,11 +6,11 @@ binaries.
 ## Prerequisites
 
 To compile mruby out of the source code you need the following tools:
-* C Compiler (e.g. ```gcc```)
-* Linker (e.g. ```gcc```)
-* Archive utility (e.g. ```ar```)
-* Parser generator (e.g. ```bison```)
-* Ruby 2.0 or later (e.g. ```ruby``` or ```jruby```)
+* C Compiler (e.g. `gcc`)
+* Linker (e.g. `gcc`)
+* Archive utility (e.g. `ar`)
+* Parser generator (e.g. `bison`)
+* Ruby 2.0 or later (e.g. `ruby` or `jruby`)
 
 Optional:
 * GIT (to update mruby source and integrate mrbgems easier)
@@ -32,10 +32,10 @@ All tools necessary to compile mruby can be set or modified here. In case
 you want to maintain an additional *build_config.rb* you can define a
 customized path using the *$MRUBY_CONFIG* environment variable.
 
-To compile just call ```./minirake``` inside of the mruby source root. To
-generate and execute the test tools call ```./minirake test```. To clean
-all build files call ```./minirake clean```. To see full command line on
-build, call ```./minirake -v```.
+To compile just call `./minirake` inside of the mruby source root. To
+generate and execute the test tools call `./minirake test`. To clean
+all build files call `./minirake clean`. To see full command line on
+build, call `./minirake -v`.
 
 ## Build Configuration
 
@@ -79,7 +79,7 @@ toolchain :android
 ```
 
 Requires the custom standalone Android NDK and the toolchain path
-in ```ANDROID_STANDALONE_TOOLCHAIN```.
+in `ANDROID_STANDALONE_TOOLCHAIN`.
 
 ### Binaries
 
@@ -97,7 +97,7 @@ conf.gem "#{root}/mrbgems/mruby-bin-mirb"
 ### File Separator
 
 Some environments require a different file separator character. It is possible to
-set the character via ```conf.file_separator```.
+set the character via `conf.file_separator`.
 ```ruby
 conf.file_separator = '/'
 ```
@@ -119,7 +119,7 @@ end
 
 C Compiler has header searcher to detect installed library.
 
-If you need a include path of header file use ```search_header_path```:
+If you need a include path of header file use `search_header_path`:
 ```ruby
 # Searches ```iconv.h```.
 # If found it will return include path of the header file.
@@ -127,7 +127,7 @@ If you need a include path of header file use ```search_header_path```:
 fail 'iconv.h not found' unless conf.cc.search_header_path 'iconv.h'
 ```
 
-If you need a full file name of header file use ```search_header```:
+If you need a full file name of header file use `search_header`:
 ```ruby
 # Searches ```iconv.h```.
 # If found it will return full path of the header file.
@@ -136,11 +136,11 @@ iconv_h = conf.cc.search_header 'iconv.h'
 print "iconv.h found: #{iconv_h}\n"
 ```
 
-Header searcher uses compiler's ```include_paths``` by default.
+Header searcher uses compiler's `include_paths` by default.
 When you are using GCC toolchain (including clang toolchain since its base is gcc toolchain)
-it will use compiler specific include paths too. (For example ```/usr/local/include```, ```/usr/include```)
+it will use compiler specific include paths too. (For example `/usr/local/include`, `/usr/include`)
 
-If you need a special header search paths define a singleton method ```header_search_paths``` to C compiler:
+If you need a special header search paths define a singleton method `header_search_paths` to C compiler:
 ```ruby
 def conf.cc.header_search_paths
   ['/opt/local/include'] + include_paths
@@ -222,7 +222,7 @@ See doc/mrbgems/README.md for more option about mrbgems.
 
 Configuration Mrbtest build process.
 
-If you want mrbtest.a only, You should set ```conf.build_mrbtest_lib_only```
+If you want mrbtest.a only, You should set `conf.build_mrbtest_lib_only`
 ```ruby
 conf.build_mrbtest_lib_only
 ```
@@ -230,9 +230,9 @@ conf.build_mrbtest_lib_only
 ### Bintest
 
 Tests for mrbgem tools using CRuby.
-To have bintests place \*.rb scripts to ```bintest/``` directory of mrbgems.
-See ```mruby-bin-*/bintest/*.rb``` if you need examples.
-If you want a temporary files use `tempfile` module of CRuby instead of ```/tmp/```.
+To have bintests place \*.rb scripts to `bintest/` directory of mrbgems.
+See `mruby-bin-*/bintest/*.rb` if you need examples.
+If you want a temporary files use `tempfile` module of CRuby instead of `/tmp/`.
 
 You can enable it with following:
 ```ruby
@@ -247,8 +247,8 @@ correctly. To support mrbgems written in C++, mruby can be
 configured to use C++ exception.
 
 There are two levels of C++ exception handling. The one is
-```enable_cxx_exception``` that enables C++ exception, but
-uses C ABI. The other is ```enable_cxx_abi``` where all
+`enable_cxx_exception` that enables C++ exception, but
+uses C ABI. The other is `enable_cxx_abi` where all
 files are compiled by C++ compiler.
 
 When you mix C++ code, C++ exception would be enabled automatically.
@@ -266,7 +266,7 @@ C++ exception, add following:
 conf.disable_cxx_exception
 ```
 and you will get an error when you try to use C++ gem.
-Note that it must be called before ```enable_cxx_exception``` or ```gem``` method.
+Note that it must be called before `enable_cxx_exception` or `gem` method.
 
 ### Debugging mode
 
@@ -276,17 +276,17 @@ conf.enable_debug
 ```
 
 When debugging mode is enabled
-* Macro ```MRB_DEBUG``` would be defined.
-	* Which means ```mrb_assert()``` macro is enabled.
-* Debug information of irep would be generated by ```mrbc```.
-	* Because ```-g``` flag would be added to ```mrbc``` runner.
+* Macro `MRB_DEBUG` would be defined.
+	* Which means `mrb_assert()` macro is enabled.
+* Debug information of irep would be generated by `mrbc`.
+	* Because `-g` flag would be added to `mrbc` runner.
     * You can have better backtrace of mruby scripts with this.
 
 ## Cross-Compilation
 
 mruby can also be cross-compiled from one platform to another. To
 achieve this the *build_config.rb* needs to contain an instance of
-```MRuby::CrossBuild```. This instance defines the compilation
+`MRuby::CrossBuild`. This instance defines the compilation
 tools and flags for the target platform. An example could look
 like this:
 ```ruby
@@ -298,12 +298,12 @@ MRuby::CrossBuild.new('32bit') do |conf|
 end
 ```
 
-All configuration options of ```MRuby::Build``` can also be used
-in ```MRuby::CrossBuild```.
+All configuration options of `MRuby::Build` can also be used
+in `MRuby::CrossBuild`.
 
 ### Mrbtest in Cross-Compilation
 
-In cross compilation, you can run ```mrbtest``` on emulator if
+In cross compilation, you can run `mrbtest` on emulator if
 you have it by changing configuration of test runner.
 ```ruby
 conf.test_runner do |t|
@@ -350,15 +350,15 @@ in *build/host/src*)
 result will be stored in *build/host/src/y.tab.c*)
 * compile  *build/host/src/y.tab.c* to  *build/host/src/y.tab.o*
 * create *build/host/lib/libmruby_core.a* out of all object files (C only)
-* create ```build/host/bin/mrbc``` by compiling *tools/mrbc/mrbc.c* and
+* create `build/host/bin/mrbc` by compiling *tools/mrbc/mrbc.c* and
 linking with *build/host/lib/libmruby_core.a*
 * create *build/host/mrblib/mrblib.c* by compiling all \*.rb files
-under *mrblib* with ```build/host/bin/mrbc```
+under *mrblib* with `build/host/bin/mrbc`
 * compile *build/host/mrblib/mrblib.c* to *build/host/mrblib/mrblib.o*
 * create *build/host/lib/libmruby.a* out of all object files (C and Ruby)
-* create ```build/host/bin/mruby``` by compiling *mrbgems/mruby-bin-mruby/tools/mruby/mruby.c* and
+* create `build/host/bin/mruby` by compiling *mrbgems/mruby-bin-mruby/tools/mruby/mruby.c* and
 linking with *build/host/lib/libmruby.a*
-* create ```build/host/bin/mirb``` by compiling *mrbgems/mruby-bin-mirb/tools/mirb/mirb.c* and
+* create `build/host/bin/mirb` by compiling *mrbgems/mruby-bin-mirb/tools/mirb/mirb.c* and
 linking with *build/host/lib/libmruby.a*
 
 ```
@@ -427,15 +427,15 @@ in *build/i386/src*)
 result will be stored in *build/i386/src/y.tab.c*)
 * cross-compile *build/i386/src/y.tab.c* to *build/i386/src/y.tab.o*
 * create *build/i386/mrblib/mrblib.c* by compiling all \*.rb files
-under *mrblib* with the native ```build/host/bin/mrbc```
+under *mrblib* with the native `build/host/bin/mrbc`
 * cross-compile *build/host/mrblib/mrblib.c* to *build/host/mrblib/mrblib.o*
 * create *build/i386/lib/libmruby.a* out of all object files (C and Ruby)
-* create ```build/i386/bin/mruby``` by cross-compiling *mrbgems/mruby-bin-mruby/tools/mruby/mruby.c* and
+* create `build/i386/bin/mruby` by cross-compiling *mrbgems/mruby-bin-mruby/tools/mruby/mruby.c* and
 linking with *build/i386/lib/libmruby.a*
-* create ```build/i386/bin/mirb``` by cross-compiling *mrbgems/mruby-bin-mirb/tools/mirb/mirb.c* and
+* create `build/i386/bin/mirb` by cross-compiling *mrbgems/mruby-bin-mirb/tools/mirb/mirb.c* and
 linking with *build/i386/lib/libmruby.a*
 * create *build/i386/lib/libmruby_core.a* out of all object files (C only)
-* create ```build/i386/bin/mrbc``` by cross-compiling *tools/mrbc/mrbc.c* and
+* create `build/i386/bin/mrbc` by cross-compiling *tools/mrbc/mrbc.c* and
 linking with *build/i386/lib/libmruby_core.a*
 
 ```
@@ -482,7 +482,7 @@ all usages of stdio and doesn't compile any binaries (e.g. mrbc).
 ## Test Environment
 
 mruby's build process includes a test environment. In case you start the testing
-of mruby, a native binary called ```mrbtest``` will be generated and executed.
+of mruby, a native binary called `mrbtest` will be generated and executed.
 This binary contains all test cases which are defined under *test/t*. In case
 of a cross-compilation an additional cross-compiled *mrbtest* binary is
 generated. You can copy this binary and run on your target system.
diff --git a/doc/limitations.md b/doc/limitations.md
index 9b4ed9c6f..20e2dc52f 100644
--- a/doc/limitations.md
+++ b/doc/limitations.md
@@ -14,17 +14,17 @@ This document does not contain a complete list of limitations.
 Please help to improve it by submitting your findings.
 
 
-## ```1/2``` gives ```0.5```
+## `1/2` gives `0.5`
 
-Since mruby does not have ```Bignum```, bigger integers are represented
-by ```Float``` numbers. To enhance interoperability between ```Fixnum```
-and ```Float```, mruby provides ```Float#upto``` and other iterating
-methods for the ```Float``` class.  As a side effect, ```1/2``` gives ```0.5```
-not ```0```.
+Since mruby does not have `Bignum`, bigger integers are represented
+by `Float` numbers. To enhance interoperability between `Fixnum`
+and `Float`, mruby provides `Float#upto` and other iterating
+methods for the `Float` class.  As a side effect, `1/2` gives `0.5`
+not `0`.
 
-## ```Array``` passed to ```puts```
+## `Array` passed to `puts`
 
-Passing an Array to ```puts``` results in different output.
+Passing an Array to `puts` results in different output.
 
 ```ruby
 puts [1,2,3]
@@ -44,9 +44,9 @@ puts [1,2,3]
 [1, 2, 3]
 ```
 
-## ```Kernel.raise``` in rescue clause
+## `Kernel.raise` in rescue clause
 
-```Kernel.raise``` without arguments does not raise the current exception within
+`Kernel.raise` without arguments does not raise the current exception within
 a rescue clause.
 
 ```ruby
@@ -59,7 +59,7 @@ end
 
 #### Ruby [ruby 2.0.0p645 (2015-04-13 revision 50299)]
 
-```ZeroDivisionError``` is raised.
+`ZeroDivisionError` is raised.
 
 #### mruby [2.0.1 (2019-4-4)]
 
@@ -67,13 +67,13 @@ No exception is raised.
 
 ## Fiber execution can't cross C function boundary
 
-mruby's ```Fiber``` is implemented in a similar way to Lua's co-routine. This
+mruby's `Fiber` is implemented in a similar way to Lua's co-routine. This
 results in the consequence that you can't switch context within C functions.
-Only exception is ```mrb_fiber_yield``` at return.
+Only exception is `mrb_fiber_yield` at return.
 
-## ```Array``` does not support instance variables
+## `Array` does not support instance variables
 
-To reduce memory consumption ```Array``` does not support instance variables.
+To reduce memory consumption `Array` does not support instance variables.
 
 ```ruby
 class Liste < Array
@@ -87,11 +87,11 @@ p Liste.new "foobar"
 
 #### Ruby [ruby 2.0.0p645 (2015-04-13 revision 50299)]
 
-``` [] ```
+` [] `
 
 #### mruby [2.0.1 (2019-4-4)]
 
-```ArgumentError``` is raised.
+`ArgumentError` is raised.
 
 ## Method visibility
 
@@ -128,8 +128,8 @@ true
 
 ## defined?
 
-The ```defined?``` keyword is considered too complex to be fully
-implemented. It is recommended to use ```const_defined?``` and
+The `defined?` keyword is considered too complex to be fully
+implemented. It is recommended to use `const_defined?` and
 other reflection methods instead.
 
 ```ruby
@@ -144,9 +144,9 @@ nil
 
 #### mruby [2.0.1 (2019-4-4)]
 
-```NameError``` is raised.
+`NameError` is raised.
 
-## ```alias``` on global variables
+## `alias` on global variables
 
 Aliasing a global variable works in CRuby but is not part
 of the ISO standard.
@@ -157,7 +157,7 @@ alias $a $__a__
 
 #### Ruby [ruby 2.0.0p645 (2015-04-13 revision 50299)]
 
-``` nil ```
+` nil `
 
 #### mruby [2.0.1 (2019-4-4)]
 
@@ -178,12 +178,12 @@ end
 
 #### Ruby [ruby 2.0.0p645 (2015-04-13 revision 50299)]
 
-```ArgumentError``` is raised.
-The re-defined ```+``` operator does not accept any arguments.
+`ArgumentError` is raised.
+The re-defined `+` operator does not accept any arguments.
 
 #### mruby [2.0.1 (2019-4-4)]
 
-``` 'ab' ```
+` 'ab' `
 Behavior of the operator wasn't changed.
 
 ## Kernel#binding is not supported
diff --git a/doc/opcode.md b/doc/opcode.md
index eab82a26f..3487f9afb 100644
--- a/doc/opcode.md
+++ b/doc/opcode.md
@@ -31,6 +31,7 @@ with `"`, either `OP_EXT1` or `OP_EXT2` or `OP_EXT2` can be prefixed.
 
 ## table.1 Instruction Table
 
+```
 |Instruction Name |Operand type |Semantics        
 |-----------------|-------------|-----------------
 |OP_NOP           | -           |                 
@@ -125,3 +126,4 @@ with `"`, either `OP_EXT1` or `OP_EXT2` or `OP_EXT2` can be prefixed.
 |OP_EXT2          |-            |make 2nd operand 16bit
 |OP_EXT3          |-            |make 1st and 2nd operands 16bit
 |OP_STOP          |-            |stop VM
+```
diff --git a/include/mruby/object.h b/include/mruby/object.h
index 1589e4c68..234cd6490 100644
--- a/include/mruby/object.h
+++ b/include/mruby/object.h
@@ -8,15 +8,14 @@
 #define MRUBY_OBJECT_H
 
 #define MRB_OBJECT_HEADER \
-  enum mrb_vtype tt:8;   \
-  uint32_t color:3;      \
-  uint32_t flags:21;     \
-  struct RClass *c;      \
-  struct RBasic *gcnext  \
+  enum mrb_vtype tt:8;    \
+  uint32_t color:3;       \
+  uint32_t flags:21;      \
+  struct RClass *c;       \
+  struct RBasic *gcnext
 
 #define MRB_FLAG_TEST(obj, flag) ((obj)->flags & (flag))
 
-
 struct RBasic {
   MRB_OBJECT_HEADER;
 };
-- 
cgit v1.2.3


From b5299b1c5832a4eb9d6c6becfab76d76570c91ab Mon Sep 17 00:00:00 2001
From: David Siaw <davidsiaw@gmail.com>
Date: Sun, 18 Aug 2019 14:53:24 +0900
Subject: fix up documentation for values

---
 Doxyfile                    |   8 +-
 doc/opcode.md               | 190 ++++++++++++++++++++++----------------------
 include/mruby.h             |  11 ++-
 include/mruby/array.h       |   4 +-
 include/mruby/boxing_nan.h  |   4 +-
 include/mruby/boxing_no.h   |   4 +-
 include/mruby/boxing_word.h |   4 +-
 include/mruby/class.h       |   4 +-
 include/mruby/common.h      |   4 +-
 include/mruby/compile.h     |   4 +-
 include/mruby/data.h        |   4 +-
 include/mruby/debug.h       |   4 +-
 include/mruby/dump.h        |   4 +-
 include/mruby/error.h       |   4 +-
 include/mruby/gc.h          |   4 +-
 include/mruby/hash.h        |   4 +-
 include/mruby/irep.h        |   4 +-
 include/mruby/istruct.h     |   4 +-
 include/mruby/khash.h       |   4 +-
 include/mruby/numeric.h     |   4 +-
 include/mruby/object.h      |   4 +-
 include/mruby/opcode.h      |   4 +-
 include/mruby/proc.h        |   4 +-
 include/mruby/range.h       |   4 +-
 include/mruby/re.h          |   4 +-
 include/mruby/string.h      |  46 +++++------
 include/mruby/throw.h       |   4 +-
 include/mruby/value.h       |  36 ++++++---
 include/mruby/variable.h    |   4 +-
 include/mruby/version.h     |   4 +-
 30 files changed, 208 insertions(+), 183 deletions(-)

(limited to 'include')

diff --git a/Doxyfile b/Doxyfile
index 74012fbb3..9ee375f86 100644
--- a/Doxyfile
+++ b/Doxyfile
@@ -40,12 +40,15 @@ SEARCH_INCLUDES        = YES
 INCLUDE_PATH           = include include/mruby
 INCLUDE_FILE_PATTERNS  = *.h
 
-CLANG_ASSISTED_PARSING = YES
-CLANG_OPTIONS          = -Iinclude
+CLANG_ASSISTED_PARSING = NO
+CLANG_OPTIONS          = -I./include
 
 # This thing creates documentation elements for everything, even when its not documented. Its a little ugly to do it right now because huge swathes of code aren't documented.
 EXTRACT_ALL            = NO
 
+# Document MRB_INLINE functions
+EXTRACT_STATIC         = YES
+
 #===========================================================================
 # BELOW THIS LINE IS CRUFT GENERATED BY doxygen -g
 # If you edit anything below this, bring it up here so its easier to read.
@@ -443,7 +446,6 @@ EXTRACT_PACKAGE        = NO
 # included in the documentation.
 # The default value is: NO.
 
-EXTRACT_STATIC         = NO
 
 # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
 # locally in source files will be included in the documentation. If set to NO,
diff --git a/doc/opcode.md b/doc/opcode.md
index 3487f9afb..574a3c83f 100644
--- a/doc/opcode.md
+++ b/doc/opcode.md
@@ -31,99 +31,97 @@ with `"`, either `OP_EXT1` or `OP_EXT2` or `OP_EXT2` can be prefixed.
 
 ## table.1 Instruction Table
 
-```
-|Instruction Name |Operand type |Semantics        
-|-----------------|-------------|-----------------
-|OP_NOP           | -           |                 
-|OP_MOVE"         |BB           |R(a) = R(b)      
-|OP_LOADL"        |BB           |R(a) = Pool(b)   
-|OP_LOADI"        |BsB          |R(a) = mrb_int(b)
-|OP_LOADI_0'      |B            |R(a) = 0
-|OP_LOADI_1'      |B            |R(a) = 1
-|OP_LOADI_2'      |B            |R(a) = 2
-|OP_LOADI_3'      |B            |R(a) = 3
-|OP_LOADSYM"      |BB           |R(a) = Syms(b)
-|OP_LOADNIL'      |B            |R(a) = nil
-|OP_LOADSELF'     |B            |R(a) = self
-|OP_LOADT'        |B            |R(a) = true
-|OP_LOADF'        |B            |R(a) = false
-|OP_GETGV"        |BB           |R(a) = getglobal(Syms(b))
-|OP_SETGV"        |BB           |setglobal(Syms(b), R(a))
-|OP_GETSV"        |BB           |R(a) = Special[b]
-|OP_SETSV"        |BB           |Special[b] = R(a)
-|OP_GETIV"        |BB           |R(a) = ivget(Syms(b))
-|OP_SETIV"        |BB           |ivset(Syms(b),R(a))
-|OP_GETCV"        |BB           |R(a) = cvget(Syms(b))
-|OP_SETCV"        |BB           |cvset(Syms(b),R(a))
-|OP_GETCONST"     |BB           |R(a) = constget(Syms(b))
-|OP_SETCONST"     |BB           |constset(Syms(b),R(a))
-|OP_GETMCNST"     |BB           |R(a) = R(a)::Syms(b)
-|OP_SETMCNST"     |BB           |R(a+1)::Syms(b) = R(a)
-|OP_GETUPVAR'     |BBB          |R(a) = uvget(b,c)
-|OP_SETUPVAR'     |BBB          |uvset(b,c,R(a))
-|OP_JMP           |S            |pc+=a
-|OP_JMPIF'        |SB           |if R(b) pc+=a
-|OP_JMPNOT'       |SB           |if !R(b) pc+=a
-|OP_ONERR         |sS           |rescue_push(pc+a)
-|OP_EXCEPT'       |B            |R(a) = exc
-|OP_RESCUE"       |BB           |R(b) = R(a).isa?(R(b))
-|OP_POPERR        |B            |a.times{rescue_pop()}
-|OP_RAISE'        |B            |raise(R(a))
-|OP_EPUSH'        |B            |ensure_push(SEQ[a])
-|OP_EPOP          |B            |A.times{ensure_pop().call}
-|OP_SENDV"        |BB           |R(a) = call(R(a),Syms(b),*R(a+1))
-|OP_SENDVB"       |BB           |R(a) = call(R(a),Syms(b),*R(a+1),&R(a+2))
-|OP_SEND"         |BBB          |R(a) = call(R(a),Syms(b),R(a+1),...,R(a+c))
-|OP_SENDB"        |BBB          |R(a) = call(R(a),Syms(Bx),R(a+1),...,R(a+c),&R(a+c+1))
-|OP_CALL'         |B            |R(a) = self.call(frame.argc, frame.argv)
-|OP_SUPER'        |BB           |R(a) = super(R(a+1),... ,R(a+b+1))
-|OP_ARGARY'       |BS           |R(a) = argument array (16=5:1:5:1:4)
-|OP_ENTER         |W            |arg setup according to flags (23=5:5:1:5:5:1:1)
-|OP_KARG"         |BB           |R(a) = kdict[Syms(Bx)]                          # todo
-|OP_KARG2"        |BB           |R(a) = kdict[Syms(Bx)]; kdict.rm(Syms(b))       # todo
-|OP_RETURN'       |B            |return R(a) (normal)
-|OP_RETURN_BLK'   |B            |return R(a) (in-block return)
-|OP_BREAK'        |B            |break R(a)
-|OP_BLKPUSH'      |BS           |R(a) = block (16=5:1:5:1:4)
-|OP_ADD"          |BB           |R(a) = R(a)+R(a+1)
-|OP_ADDI"         |BBB          |R(a) = R(a)+mrb_int(c)
-|OP_SUB"          |BB           |R(a) = R(a)-R(a+1)
-|OP_SUBI"         |BB           |R(a) = R(a)-C
-|OP_MUL"          |BB           |R(a) = R(a)*R(a+1)
-|OP_DIV"          |BB           |R(a) = R(a)/R(a+1)
-|OP_EQ"           |BB           |R(a) = R(a)==R(a+1)
-|OP_LT"           |BB           |R(a) = R(a)<R(a+1)
-|OP_LE"           |BB           |R(a) = R(a)<=R(a+1)
-|OP_GT"           |BB           |R(a) = R(a)>R(a+1)
-|OP_GE"           |BB           |R(a) = R(a)>=R(a+1)
-|OP_ARRAY'        |BB           |R(a) = ary_new(R(a),R(a+1)..R(a+b))
-|OP_ARRAY2"       |BB           |R(a) = ary_new(R(b),R(b+1)..R(b+c))
-|OP_ARYCAT'       |B            |ary_cat(R(a),R(a+1))
-|OP_ARYPUSH'      |B            |ary_push(R(a),R(a+1))
-|OP_AREF'         |BB           |R(a) = R(a)[b]
-|OP_ASET'         |BB           |R(a)[b] = R(a+1)
-|OP_APOST'        |BB           |*R(a),R(A+1)..R(A+C) = R(a)[B..]
-|OP_STRING"       |BB           |R(a) = str_dup(Lit(b))
-|OP_STRCAT'       |B            |str_cat(R(a),R(a+1))
-|OP_HASH'         |BB           |R(a) = hash_new(R(a),R(a+1)..R(a+b))
-|OP_HASHADD'      |BB           |R(a) = hash_push(R(a),R(a+1)..R(a+b))
-|OP_LAMBDA"       |BB           |R(a) = lambda(SEQ[b],OP_L_LAMBDA)
-|OP_BLOCK"        |BB           |R(a) = lambda(SEQ[b],OP_L_BLOCK)
-|OP_METHOD"       |BB           |R(a) = lambda(SEQ[b],OP_L_METHOD)
-|OP_RANGE_INC'    |B            |R(a) = range_new(R(a),R(a+1),FALSE)
-|OP_RANGE_EXC'    |B            |R(a) = range_new(R(a),R(a+1),TRUE)
-|OP_OCLASS'       |B            |R(a) = ::Object
-|OP_CLASS"        |BB           |R(a) = newclass(R(a),Syms(b),R(a+1))
-|OP_MODULE"       |BB           |R(a) = newmodule(R(a),Syms(b))
-|OP_EXEC"         |BB           |R(a) = blockexec(R(a),SEQ[b])
-|OP_DEF"          |BB           |R(a).newmethod(Syms(b),R(a+1))
-|OP_ALIAS'        |B            |alias_method(R(a),R(a+1),R(a+2))
-|OP_UNDEF"        |BB           |undef_method(R(a),Syms(b))
-|OP_SCLASS'       |B            |R(a) = R(a).singleton_class
-|OP_TCLASS'       |B            |R(a) = target_class
-|OP_ERR'          |B            |raise(RuntimeError, Lit(Bx))
-|OP_EXT1          |-            |make 1st operand 16bit
-|OP_EXT2          |-            |make 2nd operand 16bit
-|OP_EXT3          |-            |make 1st and 2nd operands 16bit
-|OP_STOP          |-            |stop VM
-```
+| Instruction Name | Operand type | Semantics        	|
+|:-----------------|--------------|---------------------|
+| OP_NOP           | -            |                  	|
+| OP_MOVE"         | BB           | R(a) = R(b)      	
+| OP_LOADL"        | BB           | R(a) = Pool(b)   	
+| OP_LOADI"        | BsB          | R(a) = mrb_int(b)	
+| OP_LOADI_0'      | B            | R(a) = 0	
+| OP_LOADI_1'      | B            | R(a) = 1	
+| OP_LOADI_2'      | B            | R(a) = 2	
+| OP_LOADI_3'      | B            | R(a) = 3	
+| OP_LOADSYM"      | BB           | R(a) = Syms(b)	
+| OP_LOADNIL'      | B            | R(a) = nil	
+| OP_LOADSELF'     | B            | R(a) = self	
+| OP_LOADT'        | B            | R(a) = true	
+| OP_LOADF'        | B            | R(a) = false	
+| OP_GETGV"        | BB           | R(a) = getglobal(Syms(b))	
+| OP_SETGV"        | BB           | setglobal(Syms(b), R(a))	
+| OP_GETSV"        | BB           | R(a) = Special[b]	
+| OP_SETSV"        | BB           | Special[b] = R(a)	
+| OP_GETIV"        | BB           | R(a) = ivget(Syms(b))	
+| OP_SETIV"        | BB           | ivset(Syms(b),R(a))	
+| OP_GETCV"        | BB           | R(a) = cvget(Syms(b))	
+| OP_SETCV"        | BB           | cvset(Syms(b),R(a))	
+| OP_GETCONST"     | BB           | R(a) = constget(Syms(b))	
+| OP_SETCONST"     | BB           | constset(Syms(b),R(a))	
+| OP_GETMCNST"     | BB           | R(a) = R(a)::Syms(b)	
+| OP_SETMCNST"     | BB           | R(a+1)::Syms(b) = R(a)	
+| OP_GETUPVAR'     | BBB          | R(a) = uvget(b,c)	
+| OP_SETUPVAR'     | BBB          | uvset(b,c,R(a))	
+| OP_JMP           | S            | pc+=a	
+| OP_JMPIF'        | SB           | if R(b) pc+=a	
+| OP_JMPNOT'       | SB           | if !R(b) pc+=a	
+| OP_ONERR         | sS           | rescue_push(pc+a)	
+| OP_EXCEPT'       | B            | R(a) = exc	
+| OP_RESCUE"       | BB           | R(b) = R(a).isa?(R(b))	
+| OP_POPERR        | B            | a.times{rescue_pop()}	
+| OP_RAISE'        | B            | raise(R(a))	
+| OP_EPUSH'        | B            | ensure_push(SEQ[a])	
+| OP_EPOP          | B            | A.times{ensure_pop().call}	
+| OP_SENDV"        | BB           | R(a) = call(R(a),Syms(b),*R(a+1))	
+| OP_SENDVB"       | BB           | R(a) = call(R(a),Syms(b),*R(a+1),&R(a+2))	
+| OP_SEND"         | BBB          | R(a) = call(R(a),Syms(b),R(a+1),...,R(a+c))	
+| OP_SENDB"        | BBB          | R(a) = call(R(a),Syms(Bx),R(a+1),...,R(a+c),&R(a+c+1))	
+| OP_CALL'         | B            | R(a) = self.call(frame.argc, frame.argv)	
+| OP_SUPER'        | BB           | R(a) = super(R(a+1),... ,R(a+b+1))	
+| OP_ARGARY'       | BS           | R(a) = argument array (16=5:1:5:1:4)	
+| OP_ENTER         | W            | arg setup according to flags (23=5:5:1:5:5:1:1)	
+| OP_KARG"         | BB           | R(a) = kdict[Syms(Bx)]                          # todo	
+| OP_KARG2"        | BB           | R(a) = kdict[Syms(Bx)]; kdict.rm(Syms(b))       # todo	
+| OP_RETURN'       | B            | return R(a) (normal)	
+| OP_RETURN_BLK'   | B            | return R(a) (in-block return)	
+| OP_BREAK'        | B            | break R(a)	
+| OP_BLKPUSH'      | BS           | R(a) = block (16=5:1:5:1:4)	
+| OP_ADD"          | BB           | R(a) = R(a)+R(a+1)	
+| OP_ADDI"         | BBB          | R(a) = R(a)+mrb_int(c)	
+| OP_SUB"          | BB           | R(a) = R(a)-R(a+1)	
+| OP_SUBI"         | BB           | R(a) = R(a)-C	
+| OP_MUL"          | BB           | R(a) = R(a)*R(a+1)	
+| OP_DIV"          | BB           | R(a) = R(a)/R(a+1)	
+| OP_EQ"           | BB           | R(a) = R(a)==R(a+1)	
+| OP_LT"           | BB           | R(a) = R(a)<R(a+1)	
+| OP_LE"           | BB           | R(a) = R(a)<=R(a+1)	
+| OP_GT"           | BB           | R(a) = R(a)>R(a+1)	
+| OP_GE"           | BB           | R(a) = R(a)>=R(a+1)	
+| OP_ARRAY'        | BB           | R(a) = ary_new(R(a),R(a+1)..R(a+b))	
+| OP_ARRAY2"       | BB           | R(a) = ary_new(R(b),R(b+1)..R(b+c))	
+| OP_ARYCAT'       | B            | ary_cat(R(a),R(a+1))	
+| OP_ARYPUSH'      | B            | ary_push(R(a),R(a+1))	
+| OP_AREF'         | BB           | R(a) = R(a)[b]	
+| OP_ASET'         | BB           | R(a)[b] = R(a+1)	
+| OP_APOST'        | BB           | *R(a),R(A+1)..R(A+C) = R(a)[B..]	
+| OP_STRING"       | BB           | R(a) = str_dup(Lit(b))	
+| OP_STRCAT'       | B            | str_cat(R(a),R(a+1))	
+| OP_HASH'         | BB           | R(a) = hash_new(R(a),R(a+1)..R(a+b))	
+| OP_HASHADD'      | BB           | R(a) = hash_push(R(a),R(a+1)..R(a+b))	
+| OP_LAMBDA"       | BB           | R(a) = lambda(SEQ[b],OP_L_LAMBDA)	
+| OP_BLOCK"        | BB           | R(a) = lambda(SEQ[b],OP_L_BLOCK)	
+| OP_METHOD"       | BB           | R(a) = lambda(SEQ[b],OP_L_METHOD)	
+| OP_RANGE_INC'    | B            | R(a) = range_new(R(a),R(a+1),FALSE)	
+| OP_RANGE_EXC'    | B            | R(a) = range_new(R(a),R(a+1),TRUE)	
+| OP_OCLASS'       | B            | R(a) = ::Object	
+| OP_CLASS"        | BB           | R(a) = newclass(R(a),Syms(b),R(a+1))	
+| OP_MODULE"       | BB           | R(a) = newmodule(R(a),Syms(b))	
+| OP_EXEC"         | BB           | R(a) = blockexec(R(a),SEQ[b])	
+| OP_DEF"          | BB           | R(a).newmethod(Syms(b),R(a+1))	
+| OP_ALIAS'        | B            | alias_method(R(a),R(a+1),R(a+2))	
+| OP_UNDEF"        | BB           | undef_method(R(a),Syms(b))	
+| OP_SCLASS'       | B            | R(a) = R(a).singleton_class	
+| OP_TCLASS'       | B            | R(a) = target_class	
+| OP_ERR'          | B            | raise(RuntimeError, Lit(Bx))	
+| OP_EXT1          | -            | make 1st operand 16bit	
+| OP_EXT2          | -            | make 2nd operand 16bit	
+| OP_EXT3          | -            | make 1st and 2nd operands 16bit	
+| OP_STOP          | -            | stop VM	
diff --git a/include/mruby.h b/include/mruby.h
index 55505a213..6ac15715e 100644
--- a/include/mruby.h
+++ b/include/mruby.h
@@ -25,6 +25,10 @@
 ** [ MIT license: http://www.opensource.org/licenses/mit-license.php ]
 */
 
+/**
+ * @file mruby.h
+ */
+
 #ifndef MRUBY_H
 #define MRUBY_H
 
@@ -97,11 +101,14 @@ MRB_BEGIN_DECL
 typedef uint8_t mrb_code;
 
 /**
- * Required arguments signature type.
+ * \class mrb_aspec
+ *
+ * Specifies the number of arguments a function takes
+ *
+ * Example: `MRB_ARGS_REQ(2) | MRB_ARGS_OPT(1)` for a method that expects 2..3 arguments
  */
 typedef uint32_t mrb_aspec;
 
-
 struct mrb_irep;
 struct mrb_state;
 
diff --git a/include/mruby/array.h b/include/mruby/array.h
index a58e0dcee..c280df3ee 100644
--- a/include/mruby/array.h
+++ b/include/mruby/array.h
@@ -1,5 +1,5 @@
-/*
-** mruby/array.h - Array class
+/**
+** @file mruby/array.h - Array class
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/boxing_nan.h b/include/mruby/boxing_nan.h
index ff6f6082d..702fa13fb 100644
--- a/include/mruby/boxing_nan.h
+++ b/include/mruby/boxing_nan.h
@@ -1,5 +1,5 @@
-/*
-** mruby/boxing_nan.h - nan boxing mrb_value definition
+/**
+** @file mruby/boxing_nan.h - nan boxing mrb_value definition
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/boxing_no.h b/include/mruby/boxing_no.h
index 86ce64555..152471913 100644
--- a/include/mruby/boxing_no.h
+++ b/include/mruby/boxing_no.h
@@ -1,5 +1,5 @@
-/*
-** mruby/boxing_no.h - unboxed mrb_value definition
+/**
+** @file mruby/boxing_no.h - unboxed mrb_value definition
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/boxing_word.h b/include/mruby/boxing_word.h
index f16968a1f..bd8105496 100644
--- a/include/mruby/boxing_word.h
+++ b/include/mruby/boxing_word.h
@@ -1,5 +1,5 @@
-/*
-** mruby/boxing_word.h - word boxing mrb_value definition
+/**
+** @file mruby/boxing_word.h - word boxing mrb_value definition
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/class.h b/include/mruby/class.h
index 169e1327b..7c925f3b3 100644
--- a/include/mruby/class.h
+++ b/include/mruby/class.h
@@ -1,5 +1,5 @@
-/*
-** mruby/class.h - Class class
+/**
+** @file mruby/class.h - Class class
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/common.h b/include/mruby/common.h
index dc9e3acc5..45ab71ef5 100644
--- a/include/mruby/common.h
+++ b/include/mruby/common.h
@@ -1,5 +1,5 @@
-/*
-**"common.h - mruby common platform definition"
+/**
+** @file common.h - mruby common platform definition"
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/compile.h b/include/mruby/compile.h
index 3b25ff526..ac9a9892a 100644
--- a/include/mruby/compile.h
+++ b/include/mruby/compile.h
@@ -1,5 +1,5 @@
-/*
-** mruby/compile.h - mruby parser
+/**
+** @file mruby/compile.h - mruby parser
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/data.h b/include/mruby/data.h
index 54466dcd6..35ec2c25b 100644
--- a/include/mruby/data.h
+++ b/include/mruby/data.h
@@ -1,5 +1,5 @@
-/*
-** mruby/data.h - Data class
+/**
+** @file mruby/data.h - Data class
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/debug.h b/include/mruby/debug.h
index e08c47cfc..f28dd645a 100644
--- a/include/mruby/debug.h
+++ b/include/mruby/debug.h
@@ -1,5 +1,5 @@
-/*
-** mruby/debug.h - mruby debug info
+/**
+** @file mruby/debug.h - mruby debug info
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/dump.h b/include/mruby/dump.h
index 65ed8af9d..46c3b63ce 100644
--- a/include/mruby/dump.h
+++ b/include/mruby/dump.h
@@ -1,5 +1,5 @@
-/*
-** mruby/dump.h - mruby binary dumper (mrbc binary format)
+/**
+** @file mruby/dump.h - mruby binary dumper (mrbc binary format)
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/error.h b/include/mruby/error.h
index 237c701ad..b795bdf4c 100644
--- a/include/mruby/error.h
+++ b/include/mruby/error.h
@@ -1,5 +1,5 @@
-/*
-** mruby/error.h - Exception class
+/**
+** @file mruby/error.h - Exception class
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/gc.h b/include/mruby/gc.h
index 2a3ff4182..4d9fb60eb 100644
--- a/include/mruby/gc.h
+++ b/include/mruby/gc.h
@@ -1,5 +1,5 @@
-/*
-** mruby/gc.h - garbage collector for mruby
+/**
+** @file mruby/gc.h - garbage collector for mruby
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/hash.h b/include/mruby/hash.h
index 7e2ed5596..734a8c3b5 100644
--- a/include/mruby/hash.h
+++ b/include/mruby/hash.h
@@ -1,5 +1,5 @@
-/*
-** mruby/hash.h - Hash class
+/**
+** @file mruby/hash.h - Hash class
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/irep.h b/include/mruby/irep.h
index d42fd0fb8..fe518e713 100644
--- a/include/mruby/irep.h
+++ b/include/mruby/irep.h
@@ -1,5 +1,5 @@
-/*
-** mruby/irep.h - mrb_irep structure
+/**
+** @file mruby/irep.h - mrb_irep structure
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/istruct.h b/include/mruby/istruct.h
index 23c9bfa36..45b1fadae 100644
--- a/include/mruby/istruct.h
+++ b/include/mruby/istruct.h
@@ -1,5 +1,5 @@
-/*
-** mruby/istruct.h - Inline structures
+/**
+** @file mruby/istruct.h - Inline structures
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/khash.h b/include/mruby/khash.h
index 9c40c6b80..c00357061 100644
--- a/include/mruby/khash.h
+++ b/include/mruby/khash.h
@@ -1,5 +1,5 @@
-/*
-** mruby/khash.c - Hash for mruby
+/**
+** @file mruby/khash.h - Hash for mruby
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/numeric.h b/include/mruby/numeric.h
index 39f6773d9..a176d96cd 100644
--- a/include/mruby/numeric.h
+++ b/include/mruby/numeric.h
@@ -1,5 +1,5 @@
-/*
-** mruby/numeric.h - Numeric, Integer, Float, Fixnum class
+/**
+** @file mruby/numeric.h - Numeric, Integer, Float, Fixnum class
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/object.h b/include/mruby/object.h
index 234cd6490..48dcc4977 100644
--- a/include/mruby/object.h
+++ b/include/mruby/object.h
@@ -1,5 +1,5 @@
-/*
-** mruby/object.h - mruby object definition
+/**
+** @file mruby/object.h - mruby object definition
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/opcode.h b/include/mruby/opcode.h
index d513ca472..95e6736a4 100644
--- a/include/mruby/opcode.h
+++ b/include/mruby/opcode.h
@@ -1,5 +1,5 @@
-/*
-** mruby/opcode.h - RiteVM operation codes
+/**
+** @file mruby/opcode.h - RiteVM operation codes
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/proc.h b/include/mruby/proc.h
index a8b16db1d..d6459f8bf 100644
--- a/include/mruby/proc.h
+++ b/include/mruby/proc.h
@@ -1,5 +1,5 @@
-/*
-** mruby/proc.h - Proc class
+/**
+** @file mruby/proc.h - Proc class
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/range.h b/include/mruby/range.h
index 500a941d5..fea700c24 100644
--- a/include/mruby/range.h
+++ b/include/mruby/range.h
@@ -1,5 +1,5 @@
-/*
-** mruby/range.h - Range class
+/**
+** @file mruby/range.h - Range class
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/re.h b/include/mruby/re.h
index 1d09d06c9..2d48019cf 100644
--- a/include/mruby/re.h
+++ b/include/mruby/re.h
@@ -1,5 +1,5 @@
-/*
-** mruby/re.h - Regexp class
+/**
+** @file mruby/re.h - Regexp class
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/string.h b/include/mruby/string.h
index aacbdbfc0..6748446f9 100644
--- a/include/mruby/string.h
+++ b/include/mruby/string.h
@@ -1,5 +1,5 @@
-/*
-** mruby/string.h - String class
+/**
+** @file mruby/string.h - String class
 **
 ** See Copyright Notice in mruby.h
 */
@@ -87,7 +87,7 @@ struct RString {
 #define RSTR_POOL_P(s) ((s)->flags & MRB_STR_POOL)
 #define RSTR_SET_POOL_FLAG(s) ((s)->flags |= MRB_STR_POOL)
 
-/*
+/**
  * Returns a pointer from a Ruby string
  */
 #define mrb_str_ptr(s)       ((struct RString*)(mrb_ptr(s)))
@@ -115,13 +115,13 @@ MRB_API void mrb_str_modify(mrb_state *mrb, struct RString *s);
 /* mrb_str_modify() with keeping ASCII flag if set */
 MRB_API void mrb_str_modify_keep_ascii(mrb_state *mrb, struct RString *s);
 
-/*
+/**
  * Finds the index of a substring in a string
  */
 MRB_API mrb_int mrb_str_index(mrb_state*, mrb_value, const char*, mrb_int, mrb_int);
 #define mrb_str_index_lit(mrb, str, lit, off) mrb_str_index(mrb, str, lit, mrb_strlen_lit(lit), off);
 
-/*
+/**
  * Appends self to other. Returns self as a concatenated string.
  *
  *
@@ -168,7 +168,7 @@ MRB_API mrb_int mrb_str_index(mrb_state*, mrb_value, const char*, mrb_int, mrb_i
  */
 MRB_API void mrb_str_concat(mrb_state*, mrb_value, mrb_value);
 
-/*
+/**
  * Adds two strings together.
  *
  *
@@ -222,7 +222,7 @@ MRB_API void mrb_str_concat(mrb_state*, mrb_value, mrb_value);
  */
 MRB_API mrb_value mrb_str_plus(mrb_state*, mrb_value, mrb_value);
 
-/*
+/**
  * Converts pointer into a Ruby string.
  *
  * @param [mrb_state] mrb The current mruby state.
@@ -231,7 +231,7 @@ MRB_API mrb_value mrb_str_plus(mrb_state*, mrb_value, mrb_value);
  */
 MRB_API mrb_value mrb_ptr_to_str(mrb_state *, void*);
 
-/*
+/**
  * Returns an object as a Ruby string.
  *
  * @param [mrb_state] mrb The current mruby state.
@@ -240,7 +240,7 @@ MRB_API mrb_value mrb_ptr_to_str(mrb_state *, void*);
  */
 MRB_API mrb_value mrb_obj_as_string(mrb_state *mrb, mrb_value obj);
 
-/*
+/**
  * Resizes the string's length. Returns the amount of characters
  * in the specified by len.
  *
@@ -280,7 +280,7 @@ MRB_API mrb_value mrb_obj_as_string(mrb_state *mrb, mrb_value obj);
  */
 MRB_API mrb_value mrb_str_resize(mrb_state *mrb, mrb_value str, mrb_int len);
 
-/*
+/**
  * Returns a sub string.
  *
  *  Example:
@@ -323,7 +323,7 @@ MRB_API mrb_value mrb_str_resize(mrb_state *mrb, mrb_value str, mrb_int len);
  */
 MRB_API mrb_value mrb_str_substr(mrb_state *mrb, mrb_value str, mrb_int beg, mrb_int len);
 
-/*
+/**
  * Returns a Ruby string type.
  *
  *
@@ -349,7 +349,7 @@ MRB_API const char *mrb_string_value_ptr(mrb_state *mrb, mrb_value str);
 /* obslete: use RSTRING_LEN() */
 MRB_API mrb_int mrb_string_value_len(mrb_state *mrb, mrb_value str);
 
-/*
+/**
  * Duplicates a string object.
  *
  *
@@ -359,7 +359,7 @@ MRB_API mrb_int mrb_string_value_len(mrb_state *mrb, mrb_value str);
  */
 MRB_API mrb_value mrb_str_dup(mrb_state *mrb, mrb_value str);
 
-/*
+/**
  * Returns a symbol from a passed in Ruby string.
  *
  * @param [mrb_state] mrb The current mruby state.
@@ -373,13 +373,13 @@ MRB_API mrb_value mrb_cstr_to_inum(mrb_state *mrb, const char *s, mrb_int base,
 MRB_API double mrb_str_to_dbl(mrb_state *mrb, mrb_value str, mrb_bool badcheck);
 MRB_API double mrb_cstr_to_dbl(mrb_state *mrb, const char *s, mrb_bool badcheck);
 
-/*
+/**
  * Returns a converted string type.
  * For type checking, non converting `mrb_to_str` is recommended.
  */
 MRB_API mrb_value mrb_str_to_str(mrb_state *mrb, mrb_value str);
 
-/*
+/**
  * Returns true if the strings match and false if the strings don't match.
  *
  * @param [mrb_state] mrb The current mruby state.
@@ -389,8 +389,8 @@ MRB_API mrb_value mrb_str_to_str(mrb_state *mrb, mrb_value str);
  */
 MRB_API mrb_bool mrb_str_equal(mrb_state *mrb, mrb_value str1, mrb_value str2);
 
-/*
- * Returns a concated string comprised of a Ruby string and a C string.
+/**
+ * Returns a concatenated string comprised of a Ruby string and a C string.
  *
  * @param [mrb_state] mrb The current mruby state.
  * @param [mrb_value] str Ruby string.
@@ -401,8 +401,8 @@ MRB_API mrb_bool mrb_str_equal(mrb_state *mrb, mrb_value str1, mrb_value str2);
  */
 MRB_API mrb_value mrb_str_cat(mrb_state *mrb, mrb_value str, const char *ptr, size_t len);
 
-/*
- * Returns a concated string comprised of a Ruby string and a C string.
+/**
+ * Returns a concatenated string comprised of a Ruby string and a C string.
  *
  * @param [mrb_state] mrb The current mruby state.
  * @param [mrb_value] str Ruby string.
@@ -414,17 +414,17 @@ MRB_API mrb_value mrb_str_cat_cstr(mrb_state *mrb, mrb_value str, const char *pt
 MRB_API mrb_value mrb_str_cat_str(mrb_state *mrb, mrb_value str, mrb_value str2);
 #define mrb_str_cat_lit(mrb, str, lit) mrb_str_cat(mrb, str, lit, mrb_strlen_lit(lit))
 
-/*
+/**
  * Adds str2 to the end of str1.
  */
 MRB_API mrb_value mrb_str_append(mrb_state *mrb, mrb_value str, mrb_value str2);
 
-/*
+/**
  * Returns 0 if both Ruby strings are equal. Returns a value < 0 if Ruby str1 is less than Ruby str2. Returns a value > 0 if Ruby str2 is greater than Ruby str1.
  */
 MRB_API int mrb_str_cmp(mrb_state *mrb, mrb_value str1, mrb_value str2);
 
-/*
+/**
  * Returns a newly allocated C string from a Ruby string.
  * This is an utility function to pass a Ruby string to C library functions.
  *
@@ -445,7 +445,7 @@ mrb_value mrb_str_pool(mrb_state *mrb, mrb_value str);
 uint32_t mrb_str_hash(mrb_state *mrb, mrb_value str);
 mrb_value mrb_str_dump(mrb_state *mrb, mrb_value str);
 
-/*
+/**
  * Returns a printable version of str, surrounded by quote marks, with special characters escaped.
  */
 mrb_value mrb_str_inspect(mrb_state *mrb, mrb_value str);
diff --git a/include/mruby/throw.h b/include/mruby/throw.h
index 4a1fd8d60..1f1298d7d 100644
--- a/include/mruby/throw.h
+++ b/include/mruby/throw.h
@@ -1,5 +1,5 @@
-/*
-** mruby/throw.h - mruby exception throwing handler
+/**
+** @file mruby/throw.h - mruby exception throwing handler
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/value.h b/include/mruby/value.h
index be3dd397f..2ba0b3587 100644
--- a/include/mruby/value.h
+++ b/include/mruby/value.h
@@ -1,5 +1,5 @@
-/*
-** mruby/value.h - mruby value definitions
+/**
+** @file mruby/value.h - mruby value definitions
 **
 ** See Copyright Notice in mruby.h
 */
@@ -9,12 +9,27 @@
 
 #include "common.h"
 
-/**
+/*
  * MRuby Value definition functions and macros.
  */
 MRB_BEGIN_DECL
 
+/**
+ * @class mrb_sym
+ * @brief mruby Symbol
+ * 
+ * You can create an mrb_sym by simply using mrb_str_intern() or mrb_intern_cstr()
+ */
 typedef uint32_t mrb_sym;
+
+/**
+ * @class mrb_bool
+ * @brief mruby Boolean
+ *
+ * Used internally to represent boolean. Can be TRUE or FALSE.
+ * Not to be confused with Ruby's boolean classes, which can be 
+ * obtained using mrb_false_value() and mrb_true_value()
+ */
 typedef uint8_t mrb_bool;
 struct mrb_state;
 
@@ -178,8 +193,10 @@ typedef void mrb_value;
 #define mrb_exception_p(o) (mrb_type(o) == MRB_TT_EXCEPTION)
 #define mrb_test(o)   mrb_bool(o)
 
-/*
+/**
  * Returns a float in Ruby.
+ *
+ * Takes a float and boxes it into an mrb_value
  */
 #ifndef MRB_WITHOUT_FLOAT
 MRB_INLINE mrb_value mrb_float_value(struct mrb_state *mrb, mrb_float f)
@@ -200,8 +217,10 @@ mrb_cptr_value(struct mrb_state *mrb, void *p)
   return v;
 }
 
-/*
+/**
  * Returns a fixnum in Ruby.
+ *
+ * Takes an integer and boxes it into an mrb_value
  */
 MRB_INLINE mrb_value mrb_fixnum_value(mrb_int i)
 {
@@ -228,8 +247,7 @@ mrb_obj_value(void *p)
   return v;
 }
 
-
-/*
+/**
  * Get a nil mrb_value object.
  *
  * @return
@@ -242,7 +260,7 @@ MRB_INLINE mrb_value mrb_nil_value(void)
   return v;
 }
 
-/*
+/**
  * Returns false in Ruby.
  */
 MRB_INLINE mrb_value mrb_false_value(void)
@@ -252,7 +270,7 @@ MRB_INLINE mrb_value mrb_false_value(void)
   return v;
 }
 
-/*
+/**
  * Returns true in Ruby.
  */
 MRB_INLINE mrb_value mrb_true_value(void)
diff --git a/include/mruby/variable.h b/include/mruby/variable.h
index ff01e5cc8..8ae33304d 100644
--- a/include/mruby/variable.h
+++ b/include/mruby/variable.h
@@ -1,5 +1,5 @@
-/*
-** mruby/variable.h - mruby variables
+/**
+** @file mruby/variable.h - mruby variables
 **
 ** See Copyright Notice in mruby.h
 */
diff --git a/include/mruby/version.h b/include/mruby/version.h
index 206078df0..3140ea481 100644
--- a/include/mruby/version.h
+++ b/include/mruby/version.h
@@ -1,5 +1,5 @@
-/*
-** mruby/version.h - mruby version definition
+/**
+** @file mruby/version.h - mruby version definition
 **
 ** See Copyright Notice in mruby.h
 */
-- 
cgit v1.2.3