Skip to content

Commit 316f3b3

Browse files
datho7561angelozerr
authored andcommitted
Document xml.symbols.maxItemsComputed
Signed-off-by: David Thompson <davthomp@redhat.com>
1 parent 027c492 commit 316f3b3

File tree

2 files changed

+17
-4
lines changed

2 files changed

+17
-4
lines changed

docs/Symbols.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
# Symbols
22

3-
## Show Referenced Grammars
3+
## xml.symbols.maxItemsComputed
4+
5+
Use `xml.symbols.maxItemsComputed` to limit the number of symbols that are computed for each XML document.
6+
This helps to prevent cases where the extension runs out of memory on large documents.
7+
This limit can also improve performance on large documents.
8+
9+
The default limit is 5000.
10+
If the limit is set to 0, no symbols are computed.
11+
If the limit is set to a negative number, all the symbols will be computed.
12+
13+
If `xml.symbols.showReferencedGrammars` is enabled, the referenced grammar symbols are included in the count.
14+
If symbols are disabled, this setting has no effect.
15+
16+
## xml.symbols.showReferencedGrammars
417

518
If `xml.symbols.showReferencedGrammars` is enabled, the referenced grammars will be listed in the document outline.
619
The following are also listed:
@@ -10,4 +23,4 @@ The following are also listed:
1023
![An XML document that references two grammars. The referenced grammars are listed in the outline](./images/Symbols/ShowReferencedGrammars.png)
1124

1225
This option has no effect if symbols are disabled through `xml.symbols.enabled`.
13-
The displayed symbols are affected by `xml.symbols.maxItemsComputed`
26+
The displayed symbols are affected by `xml.symbols.maxItemsComputed`

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -351,12 +351,12 @@
351351
"xml.symbols.maxItemsComputed": {
352352
"type": "integer",
353353
"default": 5000,
354-
"markdownDescription": "The maximum number of outline symbols and folding regions computed (limited for performance reasons). Default is `5000`."
354+
"markdownDescription": "The maximum number of outline symbols and folding regions computed (limited for performance reasons). Default is `5000`. Please see [here](command:xml.open.docs?%5B%7B%22page%22%3A%22Symbols%22%2C%22section%22%3A%22xmlsymbolsmaxitemscomputed%22%7D%5D) for more information."
355355
},
356356
"xml.symbols.showReferencedGrammars": {
357357
"type": "boolean",
358358
"default": true,
359-
"markdownDescription": "Show referenced grammars in the Outline. Default is `true`. Please see [here](command:xml.open.docs?%5B%7B%22page%22%3A%22Symbols%22%2C%22section%22%3A%22show-referenced-grammars%22%7D%5D) for more information.",
359+
"markdownDescription": "Show referenced grammars in the Outline. Default is `true`. Please see [here](command:xml.open.docs?%5B%7B%22page%22%3A%22Symbols%22%2C%22section%22%3A%22xmlsymbolsshowreferencedgrammars%22%7D%5D) for more information.",
360360
"scope": "window"
361361
},
362362
"xml.extension.jars": {

0 commit comments

Comments
 (0)