Improve docs

midori-rb · Oct 27, 2016 · 5420777 · 5420777
1 parent 5f17ac6
commit 5420777
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 10 deletions.
diff --git a/README.md b/README.md
@@ -144,13 +144,13 @@ Obey [Contribute Code of Conduct](CONTRIBUTE_CODE_OF_CONDUCT.md) before you leav
 |    0.0.8     |   2016-10-18    | 2016-10-16 (-2d) | Implement EventSource                  |
 |    0.0.9     |   2016-10-25    | 2016-10-17 (-8d) | Implement Middleware                   |
 |  **0.1.0**   |   2016-11-01    |                  | Enrich API and documenting (dev ready) |
-|    0.1.1     |   2016-11-08    |                  | Improve Parser Performance             |
-|    0.1.2     |   2016-11-22    |                  | Path to Database                       |
-|    0.1.3     |   2016-12-06    |                  | Database Driver for Postgres           |
-|    0.1.4     |   2016-12-13    |                  | Database Driver for MySQL              |
-|    0.1.5     |   2016-12-20    |                  | Database Driver for MongoDB            |
-|    0.1.6     |   2016-01-03    |                  | Path to ORM                            |
-|    0.1.7     |   2016-01-10    |                  | File I/O                               |
+|    0.1.1     |   2016-11-08    |                  | API Mount Syntax                       |
+|    0.1.2     |   2016-11-15    |                  | Better Error Handler                   |
+|    0.1.3     |   2016-11-22    |                  | File I/O                               |
+|    0.1.4     |   2016-12-06    |                  | Implement Database Driver              |
+|    0.1.5     |   2016-12-20    |                  | Implement Database ORM                 |
+|    0.1.6     |   2016-01-03    |                  | Enrich Database                        |
+|    0.1.7     |   2016-01-10    |                  | Enrich ORM                             |
 |    0.1.8     |   2016-01-17    |                  | Tutorial                               |
 |    0.1.9     |   2016-01-24    |                  | Official Wiki                          |
 |    0.2.0     |   2016-01-31    |                  | Enrich API and documenting             |

diff --git a/lib/em-midori.rb b/lib/em-midori.rb
@@ -6,8 +6,8 @@
 require 'http/parser'
 require 'socket'
 
-require_relative 'em-midori/core_ext/configurable'
 require_relative 'em-midori/version'
+require_relative 'em-midori/core_ext/configurable'
 require_relative 'em-midori/string'
 require_relative 'em-midori/promise'
 require_relative 'em-midori/const'

diff --git a/lib/em-midori/configure.rb b/lib/em-midori/configure.rb
@@ -1,3 +1,5 @@
+##
+# Default configuration of Midori, extends +Midori::Configurable+
 class Midori::Configure
   extend Midori::Configurable
 

diff --git a/lib/em-midori/const.rb b/lib/em-midori/const.rb
@@ -58,6 +58,7 @@ module Midori::Const
     'Connection' => 'keep-alive'
   }
 
+  # Default header for Websocket response
   WEBSOCKET_HEADER = {
     'Upgrade' => 'websocket',
     'Connection' => 'Upgrade'

diff --git a/lib/em-midori/core_ext/configurable.rb b/lib/em-midori/core_ext/configurable.rb
@@ -1,8 +1,11 @@
 module Midori
+  # Provide flexible configuration for Midori Server
   module Configurable
     # Modified from Sinatra
-    # Sets an option to the given value.  If the value is a proc,
-    # the proc will be called every time the option is accessed.
+    # Sets an option to the given value.
+    # @param [Symbol] option the name of config
+    # @param [Object] value value to the name
+    # @param [Boolean] read_only Generate option= method or not
     def set(option, value = (not_set = true), read_only = false)
       raise ArgumentError if not_set
 

diff --git a/lib/em-midori/runner.rb b/lib/em-midori/runner.rb
@@ -1,3 +1,5 @@
+##
+# Abstract runner class to control instance of Midori Server
 class Midori::Runner
   attr_reader :bind, :port
 

diff --git a/lib/em-midori/version.rb b/lib/em-midori/version.rb
@@ -1,3 +1,4 @@
+# Midori Module
 module Midori
   # Current Version Code
   VERSION = '0.0.9.5'.freeze