aboutsummaryrefslogtreecommitdiffstats
path: root/lsp/vhdl_ls.lua
diff options
context:
space:
mode:
authorJustin M. Keyes <justinkz@gmail.com>2025-04-18 17:44:38 +0200
committerJustin M. Keyes <justinkz@gmail.com>2025-04-18 17:44:38 +0200
commitf8b5cbe6312b568def1f91d747e2cdb8984fdf2e (patch)
treec1baf319b22d8ccc7d3468276b5ba9a26dfa2775 /lsp/vhdl_ls.lua
parentfeat: angularls #3746 (diff)
downloadnvim-lspconfig-f8b5cbe6312b568def1f91d747e2cdb8984fdf2e.tar
nvim-lspconfig-f8b5cbe6312b568def1f91d747e2cdb8984fdf2e.tar.gz
nvim-lspconfig-f8b5cbe6312b568def1f91d747e2cdb8984fdf2e.tar.bz2
nvim-lspconfig-f8b5cbe6312b568def1f91d747e2cdb8984fdf2e.tar.lz
nvim-lspconfig-f8b5cbe6312b568def1f91d747e2cdb8984fdf2e.tar.xz
nvim-lspconfig-f8b5cbe6312b568def1f91d747e2cdb8984fdf2e.tar.zst
nvim-lspconfig-f8b5cbe6312b568def1f91d747e2cdb8984fdf2e.zip
docs: cleanup
- brief should live at the top of each file - fix indentation for some docs
Diffstat (limited to 'lsp/vhdl_ls.lua')
-rw-r--r--lsp/vhdl_ls.lua52
1 files changed, 26 insertions, 26 deletions
diff --git a/lsp/vhdl_ls.lua b/lsp/vhdl_ls.lua
index 1d93c350..5ca68107 100644
--- a/lsp/vhdl_ls.lua
+++ b/lsp/vhdl_ls.lua
@@ -1,31 +1,31 @@
---@brief
---
--- Install vhdl_ls from https://github.com/VHDL-LS/rust_hdl and add it to path
---
--- Configuration
---
--- The language server needs to know your library mapping to perform full analysis of the code. For this it uses a configuration file in the TOML format named vhdl_ls.toml.
---
--- vhdl_ls will load configuration files in the following order of priority (first to last):
---
--- A file named .vhdl_ls.toml in the user home folder.
--- A file name from the VHDL_LS_CONFIG environment variable.
--- A file named vhdl_ls.toml in the workspace root.
---
--- Settings in a later files overwrites those from previously loaded files.
---
--- Example vhdl_ls.toml
--- ```
--- # File names are either absolute or relative to the parent folder of the vhdl_ls.toml file
--- [libraries]
--- lib2.files = [
--- 'pkg2.vhd',
--- ]
--- lib1.files = [
--- 'pkg1.vhd',
--- 'tb_ent.vhd'
--- ]
--- ```
+--- Install vhdl_ls from https://github.com/VHDL-LS/rust_hdl and add it to path
+---
+--- Configuration
+---
+--- The language server needs to know your library mapping to perform full analysis of the code. For this it uses a configuration file in the TOML format named vhdl_ls.toml.
+---
+--- vhdl_ls will load configuration files in the following order of priority (first to last):
+---
+--- A file named .vhdl_ls.toml in the user home folder.
+--- A file name from the VHDL_LS_CONFIG environment variable.
+--- A file named vhdl_ls.toml in the workspace root.
+---
+--- Settings in a later files overwrites those from previously loaded files.
+---
+--- Example vhdl_ls.toml
+--- ```
+--- # File names are either absolute or relative to the parent folder of the vhdl_ls.toml file
+--- [libraries]
+--- lib2.files = [
+--- 'pkg2.vhd',
+--- ]
+--- lib1.files = [
+--- 'pkg1.vhd',
+--- 'tb_ent.vhd'
+--- ]
+--- ```
return {
cmd = { 'vhdl_ls' },
filetypes = { 'vhd', 'vhdl' },