rename Method to InstanceMethod

Author: adlerhsieh

class.go

@@ -8,14 +8,14 @@ import (
 type Classes []Class
 
 type Class struct {
-	Methods Methods `json:"methods"`
-	Name    string  `json:"name"`
-	Line    int     `json:"line"`
-	// Comment string  `json:"comment"`
-	Comment  template.HTML `json:"comment"`
-	Filename string
-	Commit   string
-	Repo     string
+	ClassMethods    Methods       `json:"class_methods"`
+	InstanceMethods Methods       `json:"instance_methods"`
+	Name            string        `json:"name"`
+	Line            int           `json:"line"`
+	Comment         template.HTML `json:"comment"`
+	Filename        string
+	Commit          string
+	Repo            string
 }
 
 func (a *Class) MatchName(str string) bool {

docs/index.html

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

html.go

@@ -41,9 +41,9 @@ func generateClassFile(classes Classes, class Class) {
 	panicIf(err)
 	classComment := blackfriday.MarkdownCommon([]byte(class.Comment))
 	class.Comment = template.HTML(string(classComment))
-	for i := 0; i < len(class.Methods); i++ {
-		methodComment := blackfriday.MarkdownCommon([]byte(class.Methods[i].Comment))
-		class.Methods[i].Comment = template.HTML(methodComment)
+	for i := 0; i < len(class.InstanceMethods); i++ {
+		methodComment := blackfriday.MarkdownCommon([]byte(class.InstanceMethods[i].Comment))
+		class.InstanceMethods[i].Comment = template.HTML(methodComment)
 	}
 	variables := map[string]interface{}{
 		"classes": classes,

parser.go

@@ -105,7 +105,7 @@ func classFromFile(filepath string) Class {
 		allMethods = append(allMethods, method)
 	}
 
-	class.Methods = allMethods
+	class.InstanceMethods = allMethods
 	return class
 }
 

templates/html/class.html

@@ -8,7 +8,7 @@ <h2>Description</h2>
 
     <h2>Instance Methods</h2>
     <hr />
-    {{ range .class.Methods }}
+    {{ range .class.InstanceMethods }}
       <h4 class="method">
         <span class="prefix">#</span>
         <span class="title">{{.FnName}}</span>