Fix extractor logic and tests

Author: StefanGajic

test-crawler/crawler_test.go

@@ -21,22 +21,22 @@ func TestCrawlSingleFileForFunctions(t *testing.T) {
 		t.Errorf("got %q, expected %q methods", len(fnsAnn), 2)
 	}
 
-	assert.Equal(t, "", fnsAnn[0].Description)
+	assert.Equal(t, "// HelloEvent simple method that just formats message.", fnsAnn[0].Description)
 	assert.Equal(t, "HelloEvent", fnsAnn[0].Name)
 	assert.Equal(t, "()", fnsAnn[0].InputParams)      // input param
 	assert.Equal(t, "string", fnsAnn[0].ReturnValues) // return param
 
-	assert.Equal(t, "", fnsAnn[1].Description)
+	assert.Equal(t, "// HelloEventWithParameter accepts one param that got formated in message.", fnsAnn[1].Description)
 	assert.Equal(t, "HelloEventWithParameter", fnsAnn[1].Name)
 	assert.Equal(t, "(param string)", fnsAnn[1].InputParams)
 	assert.Equal(t, "(string, error)", fnsAnn[1].ReturnValues)
 
-	assert.Equal(t, "", fnsAnn[2].Description)
+	assert.Equal(t, "// FunctionWithoutParameters...", fnsAnn[2].Description)
 	assert.Equal(t, "FunctionWithoutParameters", fnsAnn[2].Name)
 	assert.Equal(t, "()", fnsAnn[2].InputParams)
 	assert.Equal(t, "", fnsAnn[2].ReturnValues)
 
-	assert.Equal(t, "", fnsAnn[3].Description)
+	assert.Equal(t, "// FunctionWithPointerReturnValue returns a simple pointer value.", fnsAnn[3].Description)
 	assert.Equal(t, "FunctionWithPointerReturnValue", fnsAnn[3].Name)
 	assert.Equal(t, "()", fnsAnn[3].InputParams)
 	assert.Equal(t, "*Event", fnsAnn[3].ReturnValues)

test-crawler/extractor/extractor.go

@@ -260,8 +260,9 @@ func getFunctionNodes(content string, treeCursor *sitter.TreeCursor, parser *a.P
 				child.Child(4): parameter_list:  (<-chan *types2.RequestEvent, error)
 			*/
 			if child.Type() == string(METHOD_DECLARATION) {
+				comment := content[prevNode.StartByte():prevNode.EndByte()]
 				if prevNode.Type() == string(COMMENT) {
-					value, annotationType, _ := parser.Parse(content[prevNode.StartByte():prevNode.EndByte()])
+					value, annotationType, _ := parser.Parse(comment)
 					if value != nil && annotationType == a.Ignore {
 						isIgnored = value.(bool)
 					}
@@ -288,6 +289,7 @@ func getFunctionNodes(content string, treeCursor *sitter.TreeCursor, parser *a.P
 				funcAnnoPair = append(funcAnnoPair, FunctionAnnotationNode{
 					Node: child,
 					Function: c.FunctionAnnotation{
+						Description:  comment,
 						Name:         funcName,
 						Public:       isPublic(funcName),
 						InputParams:  params,