From 50f5d078c9677dd56203edd7fabd95460c247d8a Mon Sep 17 00:00:00 2001 From: Kafkalasch Date: Mon, 17 Jun 2024 11:56:49 +0200 Subject: [PATCH 1/2] fix: fixes a bug that could select wrong tag description markdown file --- parser.go | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/parser.go b/parser.go index 8a47d0046..4a5388f0e 100644 --- a/parser.go +++ b/parser.go @@ -885,6 +885,13 @@ func isGeneralAPIComment(comments []string) bool { } func getMarkdownForTag(tagName string, dirPath string) ([]byte, error) { + if tagName == "" { + // this happens when parsing the @description.markdown attribute + // it will be called properly another time with tagName="api" + // so we can safely return an empty byte slice here + return make([]byte, 0), nil + } + dirEntries, err := os.ReadDir(dirPath) if err != nil { return nil, err @@ -897,11 +904,9 @@ func getMarkdownForTag(tagName string, dirPath string) ([]byte, error) { fileName := entry.Name() - if !strings.Contains(fileName, ".md") { - continue - } + expectedFileName := tagName + ".md" - if strings.Contains(fileName, tagName) { + if fileName == expectedFileName { fullPath := filepath.Join(dirPath, fileName) commentInfo, err := os.ReadFile(fullPath) From a87ade4289eff0075826ac943c7d0584a210e4d8 Mon Sep 17 00:00:00 2001 From: Kafkalasch Date: Mon, 1 Jul 2024 10:37:50 +0200 Subject: [PATCH 2/2] fixes parser to be able to parse file names with and without ext --- parser.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/parser.go b/parser.go index 4a5388f0e..e6bcf941a 100644 --- a/parser.go +++ b/parser.go @@ -904,7 +904,10 @@ func getMarkdownForTag(tagName string, dirPath string) ([]byte, error) { fileName := entry.Name() - expectedFileName := tagName + ".md" + expectedFileName := tagName + if !strings.HasSuffix(tagName, ".md") { + expectedFileName = tagName + ".md" + } if fileName == expectedFileName { fullPath := filepath.Join(dirPath, fileName)