dave/wowdoc-scraper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add function description parsing

Browse Source
This commit is contained in:
PhatPhuckDave
2024-11-06 00:28:17 +01:00
parent 0e289d282a
commit 0cdc57bf9a
3 changed files with 16 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
function.go
View File

@@ -30,6 +30,7 @@ func init() {
type ( type (
Function struct { Function struct {
Name string Name string
Description string
Arguments []Parameter Arguments []Parameter
Returns []Parameter Returns []Parameter
} }

2
function.tmpl
View File

@@ -1,8 +1,10 @@
---@diagnostic disable: missing-return, lowercase-global ---@diagnostic disable: missing-return, lowercase-global
{{range .Arguments -}} {{range .Arguments -}}
---@param {{.Name}} {{.Type}} {{.Description}} ---@param {{.Name}} {{.Type}} {{.Description}}
{{end -}} {{end -}}
{{range .Returns -}} {{range .Returns -}}
---@return {{.Type}} {{.Name}} {{if .Description}}#{{.Description}}{{end}} ---@return {{.Type}} {{.Name}} {{if .Description}}#{{.Description}}{{end}}
{{end -}} {{end -}}
{{if .Description}}---{{.Description}}{{end}}
function {{.Name}}({{range $index, $param := .Arguments}}{{if $index}}, {{end}}{{$param.Name}}{{end}}) end function {{.Name}}({{range $index, $param := .Arguments}}{{if $index}}, {{end}}{{$param.Name}}{{end}}) end

10
html-parser.go
View File

@@ -38,6 +38,16 @@ func ParseDoc(html string) (Function, error) {
return res, fmt.Errorf("failed parsing html: %v", err) return res, fmt.Errorf("failed parsing html: %v", err)
} }
doc.Find("div.api-desc").Each(func(i int, s *goquery.Selection) {
log.Printf("Parsing description %s", s.Text())
desc := s.Text()
desc = strings.ReplaceAll(desc, "\n", " ")
desc = strings.ReplaceAll(desc, "\t", " ")
desc = strings.ReplaceAll(desc, " ", " ")
desc = strings.TrimSpace(desc)
res.Description = desc
})
isArgs := false isArgs := false
isReturn := false isReturn := false
doc.Find("div.api-listing > p, div.api-listing > ul").Each(func(i int, s *goquery.Selection) { doc.Find("div.api-listing > p, div.api-listing > ul").Each(func(i int, s *goquery.Selection) {