Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2024-09-20 14:32:02 +00:00
Code Issues Projects Releases Packages Wiki Activity

Updated docs.

Browse source
This commit is contained in:
Kevin DeLorey 2021-07-22 19:04:27 -06:00
parent efb6587664
commit 7797c59f18
3 changed files with 49 additions and 28 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

17
crates/rust-analyzer/src/config.rs
View file

@ -147,6 +147,15 @@ config_data! {
/// also need to add the folders to Code's `files.watcherExclude`.
files_excludeDirs: Vec<PathBuf> = "[]",
/// Enables highlighting of related references while hovering your mouse above any identifier.
highlightRelated_references: bool = "true",
/// Enables highlighting of all exit points while hovering your mouse above any `return`, `?`, or return type arrow (`->`).
highlightRelated_exitPoints: bool = "true",
/// Enables highlighting of related references while hovering your mouse `break`, `loop`, `while`, or `for` keywords.
highlightRelated_breakPoints: bool = "true",
/// Enables highlighting of all break points for a loop or block context while hovering your mouse above any `async` or `await` keywords.
highlightRelated_yieldPoints: bool = "true",
/// Use semantic tokens for strings.
///
/// In some editors (e.g. vscode) semantic tokens override other highlighting grammars.
@ -261,14 +270,6 @@ config_data! {
workspace_symbol_search_scope: WorskpaceSymbolSearchScopeDef = "\"workspace\"",
/// Workspace symbol search kind.
workspace_symbol_search_kind: WorskpaceSymbolSearchKindDef = "\"only_types\"",
highlightRelated_references: bool = "true",
highlightRelated_exitPoints: bool = "true",
highlightRelated_breakPoints: bool = "true",
highlightRelated_yieldPoints: bool = "true",
}
}

20
docs/user/generated_config.adoc
View file

@ -208,6 +208,26 @@ These directories will be ignored by rust-analyzer. They are
relative to the workspace root, and globs are not supported. You may
also need to add the folders to Code's `files.watcherExclude`.
--
[[rust-analyzer.highlightRelated.references]]rust-analyzer.highlightRelated.references (default: `true`)::
+
--
Enables highlighting of related references while hovering your mouse above any identifier.
--
[[rust-analyzer.highlightRelated.exitPoints]]rust-analyzer.highlightRelated.exitPoints (default: `true`)::
+
--
Enables highlighting of all exit points while hovering your mouse above any `return`, `?`, or return type arrow (`->`).
--
[[rust-analyzer.highlightRelated.breakPoints]]rust-analyzer.highlightRelated.breakPoints (default: `true`)::
+
--
Enables highlighting of related references while hovering your mouse `break`, `loop`, `while`, or `for` keywords.
--
[[rust-analyzer.highlightRelated.yieldPoints]]rust-analyzer.highlightRelated.yieldPoints (default: `true`)::
+
--
Enables highlighting of all break points for a loop or block context while hovering your mouse above any `async` or `await` keywords.
--
[[rust-analyzer.highlighting.strings]]rust-analyzer.highlighting.strings (default: `true`)::
+
--

40
editors/code/package.json
View file

@ -655,6 +655,26 @@
"type": "string"
}
},
"rust-analyzer.highlightRelated.references": {
"markdownDescription": "Enables highlighting of related references while hovering your mouse above any identifier.",
"default": true,
"type": "boolean"
},
"rust-analyzer.highlightRelated.exitPoints": {
"markdownDescription": "Enables highlighting of all exit points while hovering your mouse above any `return`, `?`, or return type arrow (`->`).",
"default": true,
"type": "boolean"
},
"rust-analyzer.highlightRelated.breakPoints": {
"markdownDescription": "Enables highlighting of related references while hovering your mouse `break`, `loop`, `while`, or `for` keywords.",
"default": true,
"type": "boolean"
},
"rust-analyzer.highlightRelated.yieldPoints": {
"markdownDescription": "Enables highlighting of all break points for a loop or block context while hovering your mouse above any `async` or `await` keywords.",
"default": true,
"type": "boolean"
},
"rust-analyzer.highlighting.strings": {
"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.",
"default": true,
@ -881,26 +901,6 @@
"Search for all symbols kinds"
]
},
"rust-analyzer.highlightRelated.references": {
"markdownDescription": "Enables highlighting of related references while hovering your mouse above any identifier.",
"default": true,
"type": "boolean"
},
"rust-analyzer.highlightRelated.exitPoints": {
"markdownDescription": "Enables highlighting of all exit points while hovering your mouse above any `return`, `?`, or return type arrow (`->`).",
"default": true,
"type": "boolean"
},
"rust-analyzer.highlightRelated.breakPoints": {
"markdownDescription": "Enables highlighting of related references while hovering your mouse `break`, `loop`, `while`, or `for` keywords.",
"default": true,
"type": "boolean"
},
"rust-analyzer.highlightRelated.yieldPoints": {
"markdownDescription": "Enables highlighting of all break points for a loop or block context while hovering your mouse above any `async` or `await` keywords.",
"default": true,
"type": "boolean"
},
"$generated-end": {}
}
},