Skip to content

Commit

Permalink
chore(build): auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
astronvimbot committed Dec 20, 2023
1 parent 5747ce6 commit 6d25aab
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
4 changes: 3 additions & 1 deletion doc/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -761,12 +761,14 @@ function astroui.status.hl.file_icon(name: string)


```lua
function astroui.status.hl.filetype_color(self: astroui.status.hl)
function astroui.status.hl.filetype_color(self?: { bufnr: integer })
-> table
```

Get the foreground color group for the current filetype

*param* `self` — component state that may hold the buffer number

*return* — the highlight group for the current filetype foreground

@usage local heirline_component = { provider = require("astroui.status").provider.fileicon(), hl = require("astroui.status").hl.filetype_color },
Expand Down
4 changes: 3 additions & 1 deletion doc/astroui.txt
Original file line number Diff line number Diff line change
Expand Up @@ -978,12 +978,14 @@ require("astroui.status").hl.file_icon("winbar") },
FILETYPE_COLOR ~

>lua
function astroui.status.hl.filetype_color(self: astroui.status.hl)
function astroui.status.hl.filetype_color(self?: { bufnr: integer })
-> table
<

Get the foreground color group for the current filetype

_param_ `self` — component state that may hold the buffer number

_return_ — the highlight group for the current filetype foreground

@usage local heirline_component = { provider =
Expand Down

0 comments on commit 6d25aab

Please sign in to comment.