add params and returns to method bar

Author: adlerhsieh

assets/app.css

@@ -122,3 +122,7 @@ code {
   font-size: 12px;
   padding-left: 5px;
 }
+
+.return-separator {
+  padding-left: 10px;
+}

comment.go

@@ -58,9 +58,15 @@ func (a *AllComments) findCommentFor(i int) CommentStruct {
 		for _, comment := range comments.List {
 			comment.Text = strings.Replace(comment.Text, "//", "", 1)
 			if IsParamSpec(comment.Text) {
-				methodComments.Params = append(methodComments.Params, ExtractParam(comment.Text))
+				param := ExtractParam(comment.Text)
+				if param.Name != "" && param.Class != "" {
+					methodComments.Params = append(methodComments.Params, param)
+				}
 			} else if IsReturnSpec(comment.Text) {
-				methodComments.Returns = append(methodComments.Returns, ExtractReturn(comment.Text))
+				r := ExtractReturn(comment.Text)
+				if r.Class != "" {
+					methodComments.Returns = append(methodComments.Returns, r)
+				}
 			} else {
 				result = append(result, comment.Text)
 			}
@@ -75,20 +81,16 @@ func ExtractParam(line string) Param {
 	param := Param{}
 	words := strings.Split(line, " ")
 	words = words[1:len(words)]
-	// fmt.Println(words)
 	if len(words) > 1 {
-		// fmt.Println(words[1])
 		param.Name = words[1]
 	}
 	if len(words) > 2 {
-		// fmt.Println(words[2])
 		class := words[2]
 		class = strings.Replace(class, "[", "", 1)
 		class = strings.Replace(class, "]", "", 1)
 		param.Class = class
 	}
 	if len(words) > 3 {
-		// fmt.Println(words[3:len(words)])
 		theRest := strings.Join(words[3:len(words)], " ")
 		param.Description = template.HTML(theRest)
 	}

html.go

@@ -9,6 +9,12 @@ import (
 	"strings"
 )
 
+var fns = template.FuncMap{
+	"last": func(index int, length int) bool {
+		return index == length-1
+	},
+}
+
 func generateIndexFile(classes Classes) {
 	indexFile, err := os.OpenFile("./docs/index.html", os.O_CREATE|os.O_WRONLY, 0777)
 	panicIf(err)
@@ -32,7 +38,7 @@ func generateIndexFile(classes Classes) {
 func generateClassFile(classes Classes, class Class) {
 	classFile, err := os.OpenFile("./docs/"+class.Filename+".html", os.O_CREATE|os.O_WRONLY, 0777)
 	panicIf(err)
-	classTemplate, err := template.New(class.Filename).ParseFiles(
+	classTemplate, err := template.New(class.Filename).Funcs(fns).ParseFiles(
 		"./templates/html/class.html",
 		"./templates/html/layout.html",
 		"./templates/html/sidebar.html",

templates/html/class.html

@@ -11,7 +11,32 @@ <h2>Instance Methods</h2>
     {{ range .class.InstanceMethods }}
       <h4 class="method">
         <a class="prefix" href="#{{.FnName}}">#</a>
-        <span class="title" id="{{.FnName}}">{{.FnName}}</span>
+        <p class="title" id="{{.FnName}}">
+          <span>{{.FnName}}</span>
+          {{ $length := len .Params }} {{ if gt $length 0 }}
+            <span>(</span>
+              {{ range $i, $e := .Params }}
+                {{ if last $i $length }}
+                  <span>{{.Name}}</span>
+                {{ else }}
+                  <span>{{.Name}}, </span>
+                {{ end }}
+              {{ end }}
+            <span>)</span>
+          {{ end }}
+          {{ $length := len .Returns }} {{ if gt $length 0 }}
+            <span class="return-separator"> => </span>
+          {{ end }}
+          {{ $length := len .Returns }} {{ if gt $length 0 }}
+            {{ range $i, $e := .Returns }}
+              {{ if last $i $length }}
+                <span>{{.Class}}</span>
+              {{ else }}
+                <span>{{.Class}}, </span>
+              {{ end }}
+            {{ end }}
+          {{ end }}
+        </p>
       </h4>
       <div class="method-comment">
         <div>