Merge branch 'master' of github.com:goby-lang/api.doc

Author: adlerhsieh

README.md

@@ -33,61 +33,4 @@ After that, commit and push them for update. GitHub will handle the rest.
 
 ## Documenting Goby Code
 
-We use Markdown to document. All markdown syntax are supported.
-
-### Documenting Classes
-
-All classes can be found in `/vm` directory. Each class is represented by a file. For example, you can find `Integer` class in `integer.go` file.
-
-The class definition can be found with the `type` named as the filename or suffixed with "Object". The documentation for this class is right above this `type`. For example, `Integer` class is documented as:
-
-```go
-// Integer represents number objects which can bring into mathematical calculations.
-//
-// ```
-// 1 + 1 # => 2
-// 2 * 2 # => 4
-// ```
-type IntegerObject struct {
-  Class *RInteger
-  Value int
-}
-```
-
-### Documenting Methods
-
-Methods of a class are stored in an array, with its name prefixed with `builtin` and suffixed with `Methods`. For example, the name for `Integer` class is `builtinIntegerMethods`.
-
-Each method comes with two keys, `Fn` and `Name`. The document of a method comes right above `Name`. For example:
-
-```go
-var builtinIntegerMethods = []*BuiltInMethod{
-  {
-    // Returns the sum of self and another Integer.
-    //
-    // ```
-    // 1 + 1
-    // ```
-    Name: "+",
-    Fn: func(receiver Object) builtinMethodBody {
-      // ...
-    },
-  },
-}
-```
-
-Remember to leave one space after `//`.
-
-### Others
-
-Currently the documentation only supports `//` comments, not `/* */`. The following style will not be parsed:
-
-```go
-/*
-  Integer represents number objects which can bring into mathematical calculations.
-*/
-type IntegerObject struct {
-  Class *RInteger
-  Value int
-}
-```
+Go to [Goby wiki](https://github.com/goby-lang/goby/wiki/Documenting-Goby-Code).