Skip to content

Commit f7f627d

Browse files
bors[bot]Nashenas88
bors[bot]
and
Nashenas88
authored
Merge #4903
4903: Add highlighting support for doc comments r=matklad a=Nashenas88 The language server protocol includes a semantic modifier for documentation. This change exports that modifier for doc comments so users can choose to highlight them differently compared to regular comments. Example: <img width="375" alt="Screen Shot 2020-06-16 at 10 34 14 AM" src="https://user-images.githubusercontent.com/1673130/84788271-f6599580-afbc-11ea-96e5-7a0215da620b.png"> CC @woody77 Co-authored-by: Paul Daniel Faria <Nashenas88@users.noreply.github.com>
2 parents 0262dba + 66fc084 commit f7f627d

File tree

5 files changed

+56
-41
lines changed

5 files changed

+56
-41
lines changed

‎crates/ra_ide/src/snapshots/highlight_doctest.html

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -39,48 +39,48 @@
3939
<span class="keyword">impl</span> <span class="struct">Foo</span> {
4040
<span class="keyword">pub</span> <span class="keyword">const</span> <span class="constant declaration">bar</span>: <span class="builtin_type">bool</span> = <span class="bool_literal">true</span>;
4141

42-
<span class="comment">/// Constructs a new `Foo`.</span>
43-
<span class="comment">///</span>
44-
<span class="comment">/// # Examples</span>
45-
<span class="comment">///</span>
46-
<span class="comment">/// ```</span>
47-
<span class="comment">/// #</span> <span class="attribute">#![</span><span class="function attribute">allow</span><span class="attribute">(unused_mut)]</span>
48-
<span class="comment">/// </span><span class="keyword">let</span> <span class="keyword">mut</span> <span class="variable declaration mutable">foo</span>: <span class="struct">Foo</span> = <span class="struct">Foo</span>::<span class="function">new</span>();
49-
<span class="comment">/// ```</span>
42+
<span class="comment documentation">/// Constructs a new `Foo`.</span>
43+
<span class="comment documentation">///</span>
44+
<span class="comment documentation">/// # Examples</span>
45+
<span class="comment documentation">///</span>
46+
<span class="comment documentation">/// ```</span>
47+
<span class="comment documentation">/// #</span> <span class="attribute">#![</span><span class="function attribute">allow</span><span class="attribute">(unused_mut)]</span>
48+
<span class="comment documentation">/// </span><span class="keyword">let</span> <span class="keyword">mut</span> <span class="variable declaration mutable">foo</span>: <span class="struct">Foo</span> = <span class="struct">Foo</span>::<span class="function">new</span>();
49+
<span class="comment documentation">/// ```</span>
5050
<span class="keyword">pub</span> <span class="keyword">const</span> <span class="keyword">fn</span> <span class="function declaration">new</span>() -&gt; <span class="struct">Foo</span> {
5151
<span class="struct">Foo</span> { <span class="field">bar</span>: <span class="bool_literal">true</span> }
5252
}
5353

54-
<span class="comment">/// `bar` method on `Foo`.</span>
55-
<span class="comment">///</span>
56-
<span class="comment">/// # Examples</span>
57-
<span class="comment">///</span>
58-
<span class="comment">/// ```</span>
59-
<span class="comment">/// </span><span class="keyword">use</span> <span class="module">x</span>::<span class="module">y</span>;
60-
<span class="comment">///</span>
61-
<span class="comment">/// </span><span class="keyword">let</span> <span class="variable declaration">foo</span> = <span class="struct">Foo</span>::<span class="function">new</span>();
62-
<span class="comment">///</span>
63-
<span class="comment">/// </span><span class="comment">// calls bar on foo</span>
64-
<span class="comment">/// </span><span class="macro">assert!</span>(foo.bar());
65-
<span class="comment">///</span>
66-
<span class="comment">/// </span><span class="keyword">let</span> <span class="variable declaration">bar</span> = <span class="variable">foo</span>.<span class="field">bar</span> || <span class="struct">Foo</span>::<span class="constant">bar</span>;
67-
<span class="comment">///</span>
68-
<span class="comment">/// </span><span class="comment">/* multi-line
69-
</span><span class="comment">/// </span><span class="comment"> comment */</span>
70-
<span class="comment">///</span>
71-
<span class="comment">/// </span><span class="keyword">let</span> <span class="variable declaration">multi_line_string</span> = <span class="string_literal">"Foo
72-
</span><span class="comment">/// </span><span class="string_literal"> bar
73-
</span><span class="comment">/// </span><span class="string_literal"> "</span>;
74-
<span class="comment">///</span>
75-
<span class="comment">/// ```</span>
76-
<span class="comment">///</span>
77-
<span class="comment">/// ```rust,no_run</span>
78-
<span class="comment">/// </span><span class="keyword">let</span> <span class="variable declaration">foobar</span> = <span class="struct">Foo</span>::<span class="function">new</span>().<span class="function">bar</span>();
79-
<span class="comment">/// ```</span>
80-
<span class="comment">///</span>
81-
<span class="comment">/// ```sh</span>
82-
<span class="comment">/// echo 1</span>
83-
<span class="comment">/// ```</span>
54+
<span class="comment documentation">/// `bar` method on `Foo`.</span>
55+
<span class="comment documentation">///</span>
56+
<span class="comment documentation">/// # Examples</span>
57+
<span class="comment documentation">///</span>
58+
<span class="comment documentation">/// ```</span>
59+
<span class="comment documentation">/// </span><span class="keyword">use</span> <span class="module">x</span>::<span class="module">y</span>;
60+
<span class="comment documentation">///</span>
61+
<span class="comment documentation">/// </span><span class="keyword">let</span> <span class="variable declaration">foo</span> = <span class="struct">Foo</span>::<span class="function">new</span>();
62+
<span class="comment documentation">///</span>
63+
<span class="comment documentation">/// </span><span class="comment">// calls bar on foo</span>
64+
<span class="comment documentation">/// </span><span class="macro">assert!</span>(foo.bar());
65+
<span class="comment documentation">///</span>
66+
<span class="comment documentation">/// </span><span class="keyword">let</span> <span class="variable declaration">bar</span> = <span class="variable">foo</span>.<span class="field">bar</span> || <span class="struct">Foo</span>::<span class="constant">bar</span>;
67+
<span class="comment documentation">///</span>
68+
<span class="comment documentation">/// </span><span class="comment">/* multi-line
69+
</span><span class="comment documentation">/// </span><span class="comment"> comment */</span>
70+
<span class="comment documentation">///</span>
71+
<span class="comment documentation">/// </span><span class="keyword">let</span> <span class="variable declaration">multi_line_string</span> = <span class="string_literal">"Foo
72+
</span><span class="comment documentation">/// </span><span class="string_literal"> bar
73+
</span><span class="comment documentation">/// </span><span class="string_literal"> "</span>;
74+
<span class="comment documentation">///</span>
75+
<span class="comment documentation">/// ```</span>
76+
<span class="comment documentation">///</span>
77+
<span class="comment documentation">/// ```rust,no_run</span>
78+
<span class="comment documentation">/// </span><span class="keyword">let</span> <span class="variable declaration">foobar</span> = <span class="struct">Foo</span>::<span class="function">new</span>().<span class="function">bar</span>();
79+
<span class="comment documentation">/// ```</span>
80+
<span class="comment documentation">///</span>
81+
<span class="comment documentation">/// ```sh</span>
82+
<span class="comment documentation">/// echo 1</span>
83+
<span class="comment documentation">/// ```</span>
8484
<span class="keyword">pub</span> <span class="keyword">fn</span> <span class="function declaration">foo</span>(&<span class="self_keyword">self</span>) -&gt; <span class="builtin_type">bool</span> {
8585
<span class="bool_literal">true</span>
8686
}

‎crates/ra_ide/src/syntax_highlighting.rs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -489,7 +489,14 @@ fn highlight_element(
489489
}
490490

491491
// Simple token-based highlighting
492-
COMMENT => HighlightTag::Comment.into(),
492+
COMMENT => {
493+
let comment = element.into_token().and_then(ast::Comment::cast)?;
494+
let h = HighlightTag::Comment;
495+
match comment.kind().doc {
496+
Some(_) => h | HighlightModifier::Documentation,
497+
None => h.into(),
498+
}
499+
}
493500
STRING | RAW_STRING | RAW_BYTE_STRING | BYTE_STRING => HighlightTag::StringLiteral.into(),
494501
ATTR => HighlightTag::Attribute.into(),
495502
INT_NUMBER | FLOAT_NUMBER => HighlightTag::NumericLiteral.into(),

‎crates/ra_ide/src/syntax_highlighting/injection.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,10 @@ use hir::Semantics;
77
use ra_syntax::{ast, AstToken, SyntaxNode, SyntaxToken, TextRange, TextSize};
88
use stdx::SepBy;
99

10-
use crate::{call_info::ActiveParameter, Analysis, HighlightTag, HighlightedRange, RootDatabase};
10+
use crate::{
11+
call_info::ActiveParameter, Analysis, HighlightModifier, HighlightTag, HighlightedRange,
12+
RootDatabase,
13+
};
1114

1215
use super::HighlightedRangeStack;
1316

@@ -118,7 +121,7 @@ pub(super) fn extract_doc_comments(
118121
range.start(),
119122
range.start() + TextSize::try_from(pos).unwrap(),
120123
),
121-
highlight: HighlightTag::Comment.into(),
124+
highlight: HighlightTag::Comment | HighlightModifier::Documentation,
122125
binding_hash: None,
123126
});
124127
line_start += range.len() - TextSize::try_from(pos).unwrap();
@@ -164,6 +167,7 @@ pub(super) fn highlight_doc_comment(
164167
h.range.start() + start_offset,
165168
h.range.end() + end_offset.unwrap_or(start_offset),
166169
);
170+
167171
stack.add(h);
168172
}
169173
}

‎crates/ra_ide/src/syntax_highlighting/tags.rs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ pub enum HighlightModifier {
5656
/// `foo` in `fn foo(x: i32)` is a definition, `foo` in `foo(90 + 2)` is
5757
/// not.
5858
Definition,
59+
Documentation,
5960
Mutable,
6061
Unsafe,
6162
}
@@ -108,6 +109,7 @@ impl HighlightModifier {
108109
HighlightModifier::Attribute,
109110
HighlightModifier::ControlFlow,
110111
HighlightModifier::Definition,
112+
HighlightModifier::Documentation,
111113
HighlightModifier::Mutable,
112114
HighlightModifier::Unsafe,
113115
];
@@ -117,6 +119,7 @@ impl HighlightModifier {
117119
HighlightModifier::Attribute => "attribute",
118120
HighlightModifier::ControlFlow => "control",
119121
HighlightModifier::Definition => "declaration",
122+
HighlightModifier::Documentation => "documentation",
120123
HighlightModifier::Mutable => "mutable",
121124
HighlightModifier::Unsafe => "unsafe",
122125
}

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,7 @@ fn semantic_token_type_and_modifiers(
331331
let modifier = match modifier {
332332
HighlightModifier::Attribute => semantic_tokens::ATTRIBUTE_MODIFIER,
333333
HighlightModifier::Definition => lsp_types::SemanticTokenModifier::DECLARATION,
334+
HighlightModifier::Documentation => lsp_types::SemanticTokenModifier::DOCUMENTATION,
334335
HighlightModifier::ControlFlow => semantic_tokens::CONTROL_FLOW,
335336
HighlightModifier::Mutable => semantic_tokens::MUTABLE,
336337
HighlightModifier::Unsafe => semantic_tokens::UNSAFE,

0 commit comments

Comments
 (0)