Skip to content

Commit 74a4cb4

Browse files
committed
Document description URLs
1 parent f124c8b commit 74a4cb4

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

schemas/vhdl_ls.schema.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
{
22
"$schema": "http://json-schema.org/draft-04/schema",
33
"id": "https://github.com/VHDL-LS/rust_hdl",
4-
"title": "Schema for the vhdl_ls language server toml configuration",
4+
"title": "vhdl_ls language server configuration",
55
"description": "Configuration schema for vhdl_ls, the VHDL language server. Defines libraries, linting rules, and code formatting preferences.",
66
"type": "object",
77
"properties": {
88
"preferred_case": {
9-
"description": "The preferred letter case for code completions and suggestions (e.g., lower, upper_snake, pascal).",
9+
"description": "The preferred letter case for code completions and suggestions (e.g., lower, upper_snake, pascal)\nhttps://github.com/VHDL-LS/rust_hdl/wiki/VHDL%E2%80%90LS-Configuration#preferred_case",
1010
"type": "string",
1111
"enum": [
1212
"lower",
@@ -18,37 +18,37 @@
1818
]
1919
},
2020
"standard": {
21-
"description": "The VHDL standard version for analysis and linting. Supports short (e.g., '08') and full (e.g., '2008') notation.",
21+
"description": "The VHDL standard version for analysis and linting. Supports short (e.g., '08') and full (e.g., '2008') notation\nhttps://github.com/VHDL-LS/rust_hdl/wiki/VHDL%E2%80%90LS-Configuration#standard",
2222
"type": "string",
2323
"enum": ["1993", "93", "2008", "08", "2019", "19"]
2424
},
2525
"libraries": {
2626
"type": "object",
27-
"description": "Defines VHDL libraries in the project. Each library name (except 'work') maps to an object specifying source files.",
27+
"description": "Defines VHDL libraries in the project. Each library name (except 'work') maps to an object specifying source files\nhttps://github.com/VHDL-LS/rust_hdl/wiki/VHDL%E2%80%90LS-Configuration#libraries",
2828
"patternProperties": {
2929
"^(?!work$).+$": {
3030
"type": "object",
3131
"description": "A VHDL library definition. Library names must not be 'work' (reserved by VHDL spec).",
3232
"properties": {
3333
"files": {
3434
"type": "array",
35-
"description": "Array of source file paths or glob patterns belonging to this library. Either absolute or relative to vhdl_ls.toml.",
35+
"description": "Array of source file paths or glob patterns belonging to this library. Either absolute or relative to vhdl_ls.toml\nhttps://github.com/VHDL-LS/rust_hdl/wiki/VHDL%E2%80%90LS-Configuration#files",
3636
"items": {
3737
"type": "string",
3838
"description": "A file path or glob pattern (e.g., 'src/**/*.vhd', 'lib/ieee.vhd')."
3939
}
4040
},
4141
"exclude": {
4242
"type": "array",
43-
"description": "Array of source file paths or glob patterns to exclude from this library.",
43+
"description": "Array of source file paths or glob patterns to exclude from this library\nhttps://github.com/VHDL-LS/rust_hdl/wiki/VHDL%E2%80%90LS-Configuration#exclude",
4444
"items": {
4545
"type": "string",
4646
"description": "A file path or glob pattern to exclude (e.g., 'legacy/*', 'src/*_old.vhd')."
4747
}
4848
},
4949
"is_third_party": {
5050
"type": "boolean",
51-
"description": "Whether this library is third-party. May affect diagnostic reporting. Defaults to false.",
51+
"description": "Whether this library is third-party. May affect diagnostic reporting. Defaults to false\nhttps://github.com/VHDL-LS/rust_hdl/wiki/VHDL%E2%80%90LS-Configuration#is_third_party",
5252
"default": false
5353
}
5454
},
@@ -60,7 +60,7 @@
6060
},
6161
"lint": {
6262
"type": "object",
63-
"description": "Configures linting rules. Each key is a rule name, and the value controls its behavior (true/false to enable/disable, or a string for specific severity).",
63+
"description": "Configures linting rules. Each key is a rule name, and the value controls its behavior (true/false to enable/disable, or a string for specific severity)\nhttps://github.com/VHDL-LS/rust_hdl/wiki/VHDL%E2%80%90LS-Configuration#lint",
6464
"patternProperties": {
6565
"^.+$": {
6666
"anyOf": [

0 commit comments

Comments
 (0)