Skip to content

Commit 7797c59

Browse files
kdeloreykdelorey
committed
Updated docs.
1 parent efb6587 commit 7797c59

File tree

3 files changed

+49
-28
lines changed

3 files changed

+49
-28
lines changed

‎crates/rust-analyzer/src/config.rs

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,15 @@ config_data! {
147147
/// also need to add the folders to Code's `files.watcherExclude`.
148148
files_excludeDirs: Vec<PathBuf> = "[]",
149149

150+
/// Enables highlighting of related references while hovering your mouse above any identifier.
151+
highlightRelated_references: bool = "true",
152+
/// Enables highlighting of all exit points while hovering your mouse above any `return`, `?`, or return type arrow (`->`).
153+
highlightRelated_exitPoints: bool = "true",
154+
/// Enables highlighting of related references while hovering your mouse `break`, `loop`, `while`, or `for` keywords.
155+
highlightRelated_breakPoints: bool = "true",
156+
/// Enables highlighting of all break points for a loop or block context while hovering your mouse above any `async` or `await` keywords.
157+
highlightRelated_yieldPoints: bool = "true",
158+
150159
/// Use semantic tokens for strings.
151160
///
152161
/// In some editors (e.g. vscode) semantic tokens override other highlighting grammars.
@@ -261,14 +270,6 @@ config_data! {
261270
workspace_symbol_search_scope: WorskpaceSymbolSearchScopeDef = "\"workspace\"",
262271
/// Workspace symbol search kind.
263272
workspace_symbol_search_kind: WorskpaceSymbolSearchKindDef = "\"only_types\"",
264-
265-
highlightRelated_references: bool = "true",
266-
267-
highlightRelated_exitPoints: bool = "true",
268-
269-
highlightRelated_breakPoints: bool = "true",
270-
271-
highlightRelated_yieldPoints: bool = "true",
272273
}
273274
}
274275

‎docs/user/generated_config.adoc

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,26 @@ These directories will be ignored by rust-analyzer. They are
208208
relative to the workspace root, and globs are not supported. You may
209209
also need to add the folders to Code's `files.watcherExclude`.
210210
--
211+
[[rust-analyzer.highlightRelated.references]]rust-analyzer.highlightRelated.references (default: `true`)::
212+
+
213+
--
214+
Enables highlighting of related references while hovering your mouse above any identifier.
215+
--
216+
[[rust-analyzer.highlightRelated.exitPoints]]rust-analyzer.highlightRelated.exitPoints (default: `true`)::
217+
+
218+
--
219+
Enables highlighting of all exit points while hovering your mouse above any `return`, `?`, or return type arrow (`->`).
220+
--
221+
[[rust-analyzer.highlightRelated.breakPoints]]rust-analyzer.highlightRelated.breakPoints (default: `true`)::
222+
+
223+
--
224+
Enables highlighting of related references while hovering your mouse `break`, `loop`, `while`, or `for` keywords.
225+
--
226+
[[rust-analyzer.highlightRelated.yieldPoints]]rust-analyzer.highlightRelated.yieldPoints (default: `true`)::
227+
+
228+
--
229+
Enables highlighting of all break points for a loop or block context while hovering your mouse above any `async` or `await` keywords.
230+
--
211231
[[rust-analyzer.highlighting.strings]]rust-analyzer.highlighting.strings (default: `true`)::
212232
+
213233
--

‎editors/code/package.json

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -655,6 +655,26 @@
655655
"type": "string"
656656
}
657657
},
658+
"rust-analyzer.highlightRelated.references": {
659+
"markdownDescription": "Enables highlighting of related references while hovering your mouse above any identifier.",
660+
"default": true,
661+
"type": "boolean"
662+
},
663+
"rust-analyzer.highlightRelated.exitPoints": {
664+
"markdownDescription": "Enables highlighting of all exit points while hovering your mouse above any `return`, `?`, or return type arrow (`->`).",
665+
"default": true,
666+
"type": "boolean"
667+
},
668+
"rust-analyzer.highlightRelated.breakPoints": {
669+
"markdownDescription": "Enables highlighting of related references while hovering your mouse `break`, `loop`, `while`, or `for` keywords.",
670+
"default": true,
671+
"type": "boolean"
672+
},
673+
"rust-analyzer.highlightRelated.yieldPoints": {
674+
"markdownDescription": "Enables highlighting of all break points for a loop or block context while hovering your mouse above any `async` or `await` keywords.",
675+
"default": true,
676+
"type": "boolean"
677+
},
658678
"rust-analyzer.highlighting.strings": {
659679
"markdownDescription": "Use semantic tokens for strings.\n\nIn some editors (e.g. vscode) semantic tokens override other highlighting grammars.\nBy disabling semantic tokens for strings, other grammars can be used to highlight\ntheir contents.",
660680
"default": true,
@@ -881,26 +901,6 @@
881901
"Search for all symbols kinds"
882902
]
883903
},
884-
"rust-analyzer.highlightRelated.references": {
885-
"markdownDescription": "Enables highlighting of related references while hovering your mouse above any identifier.",
886-
"default": true,
887-
"type": "boolean"
888-
},
889-
"rust-analyzer.highlightRelated.exitPoints": {
890-
"markdownDescription": "Enables highlighting of all exit points while hovering your mouse above any `return`, `?`, or return type arrow (`->`).",
891-
"default": true,
892-
"type": "boolean"
893-
},
894-
"rust-analyzer.highlightRelated.breakPoints": {
895-
"markdownDescription": "Enables highlighting of related references while hovering your mouse `break`, `loop`, `while`, or `for` keywords.",
896-
"default": true,
897-
"type": "boolean"
898-
},
899-
"rust-analyzer.highlightRelated.yieldPoints": {
900-
"markdownDescription": "Enables highlighting of all break points for a loop or block context while hovering your mouse above any `async` or `await` keywords.",
901-
"default": true,
902-
"type": "boolean"
903-
},
904904
"$generated-end": {}
905905
}
906906
},

0 commit comments

Comments
 (0)