Skip to content

Commit aae26bc

Browse files
Nashenas88Nashenas88
committed
Add highlighting support for doc comments
1 parent 931f317 commit aae26bc

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
@@ -38,48 +38,48 @@
3838
<span class="keyword">impl</span> <span class="struct">Foo</span> {
3939
<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>;
4040

41-
<span class="comment">/// Constructs a new `Foo`.</span>
42-
<span class="comment">///</span>
43-
<span class="comment">/// # Examples</span>
44-
<span class="comment">///</span>
45-
<span class="comment">/// ```</span>
46-
<span class="comment">/// #</span> <span class="attribute">#![</span><span class="function attribute">allow</span><span class="attribute">(unused_mut)]</span>
47-
<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>();
48-
<span class="comment">/// ```</span>
41+
<span class="comment documentation">/// Constructs a new `Foo`.</span>
42+
<span class="comment documentation">///</span>
43+
<span class="comment documentation">/// # Examples</span>
44+
<span class="comment documentation">///</span>
45+
<span class="comment documentation">/// ```</span>
46+
<span class="comment documentation">/// #</span> <span class="attribute">#![</span><span class="function attribute">allow</span><span class="attribute">(unused_mut)]</span>
47+
<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>();
48+
<span class="comment documentation">/// ```</span>
4949
<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> {
5050
<span class="struct">Foo</span> { <span class="field">bar</span>: <span class="bool_literal">true</span> }
5151
}
5252

53-
<span class="comment">/// `bar` method on `Foo`.</span>
54-
<span class="comment">///</span>
55-
<span class="comment">/// # Examples</span>
56-
<span class="comment">///</span>
57-
<span class="comment">/// ```</span>
58-
<span class="comment">/// </span><span class="keyword">use</span> <span class="module">x</span>::<span class="module">y</span>;
59-
<span class="comment">///</span>
60-
<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>();
61-
<span class="comment">///</span>
62-
<span class="comment">/// </span><span class="comment">// calls bar on foo</span>
63-
<span class="comment">/// </span><span class="macro">assert!</span>(foo.bar());
64-
<span class="comment">///</span>
65-
<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>;
66-
<span class="comment">///</span>
67-
<span class="comment">/// </span><span class="comment">/* multi-line
68-
</span><span class="comment">/// </span><span class="comment"> comment */</span>
69-
<span class="comment">///</span>
70-
<span class="comment">/// </span><span class="keyword">let</span> <span class="variable declaration">multi_line_string</span> = <span class="string_literal">"Foo
71-
</span><span class="comment">/// </span><span class="string_literal"> bar
72-
</span><span class="comment">/// </span><span class="string_literal"> "</span>;
73-
<span class="comment">///</span>
74-
<span class="comment">/// ```</span>
75-
<span class="comment">///</span>
76-
<span class="comment">/// ```rust,no_run</span>
77-
<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>();
78-
<span class="comment">/// ```</span>
79-
<span class="comment">///</span>
80-
<span class="comment">/// ```sh</span>
81-
<span class="comment">/// echo 1</span>
82-
<span class="comment">/// ```</span>
53+
<span class="comment documentation">/// `bar` method on `Foo`.</span>
54+
<span class="comment documentation">///</span>
55+
<span class="comment documentation">/// # Examples</span>
56+
<span class="comment documentation">///</span>
57+
<span class="comment documentation">/// ```</span>
58+
<span class="comment documentation">/// </span><span class="keyword">use</span> <span class="module">x</span>::<span class="module">y</span>;
59+
<span class="comment documentation">///</span>
60+
<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>();
61+
<span class="comment documentation">///</span>
62+
<span class="comment documentation">/// </span><span class="comment">// calls bar on foo</span>
63+
<span class="comment documentation">/// </span><span class="macro">assert!</span>(foo.bar());
64+
<span class="comment documentation">///</span>
65+
<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>;
66+
<span class="comment documentation">///</span>
67+
<span class="comment documentation">/// </span><span class="comment">/* multi-line
68+
</span><span class="comment documentation">/// </span><span class="comment"> comment */</span>
69+
<span class="comment documentation">///</span>
70+
<span class="comment documentation">/// </span><span class="keyword">let</span> <span class="variable declaration">multi_line_string</span> = <span class="string_literal">"Foo
71+
</span><span class="comment documentation">/// </span><span class="string_literal"> bar
72+
</span><span class="comment documentation">/// </span><span class="string_literal"> "</span>;
73+
<span class="comment documentation">///</span>
74+
<span class="comment documentation">/// ```</span>
75+
<span class="comment documentation">///</span>
76+
<span class="comment documentation">/// ```rust,no_run</span>
77+
<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>();
78+
<span class="comment documentation">/// ```</span>
79+
<span class="comment documentation">///</span>
80+
<span class="comment documentation">/// ```sh</span>
81+
<span class="comment documentation">/// echo 1</span>
82+
<span class="comment documentation">/// ```</span>
8383
<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> {
8484
<span class="bool_literal">true</span>
8585
}

‎crates/ra_ide/src/syntax_highlighting.rs

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -475,7 +475,14 @@ fn highlight_element(
475475
}
476476

477477
// Simple token-based highlighting
478-
COMMENT => HighlightTag::Comment.into(),
478+
COMMENT => {
479+
let comment = element.into_token().and_then(ast::Comment::cast)?;
480+
if comment.kind().doc.is_some() {
481+
Highlight::from(HighlightTag::Comment) | HighlightModifier::Documentation
482+
} else {
483+
HighlightTag::Comment.into()
484+
}
485+
}
479486
STRING | RAW_STRING | RAW_BYTE_STRING | BYTE_STRING => HighlightTag::StringLiteral.into(),
480487
ATTR => HighlightTag::Attribute.into(),
481488
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, Highlight, HighlightModifier, HighlightTag,
12+
HighlightedRange, RootDatabase,
13+
};
1114

1215
use super::HighlightedRangeStack;
1316

@@ -118,7 +121,8 @@ 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: Highlight::from(HighlightTag::Comment)
125+
| HighlightModifier::Documentation,
122126
binding_hash: None,
123127
});
124128
line_start += range.len() - TextSize::try_from(pos).unwrap();

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,7 @@ pub enum HighlightModifier {
5555
/// `foo` in `fn foo(x: i32)` is a definition, `foo` in `foo(90 + 2)` is
5656
/// not.
5757
Definition,
58+
Documentation,
5859
Mutable,
5960
Unsafe,
6061
}
@@ -106,6 +107,7 @@ impl HighlightModifier {
106107
HighlightModifier::Attribute,
107108
HighlightModifier::ControlFlow,
108109
HighlightModifier::Definition,
110+
HighlightModifier::Documentation,
109111
HighlightModifier::Mutable,
110112
HighlightModifier::Unsafe,
111113
];
@@ -115,6 +117,7 @@ impl HighlightModifier {
115117
HighlightModifier::Attribute => "attribute",
116118
HighlightModifier::ControlFlow => "control",
117119
HighlightModifier::Definition => "declaration",
120+
HighlightModifier::Documentation => "documentation",
118121
HighlightModifier::Mutable => "mutable",
119122
HighlightModifier::Unsafe => "unsafe",
120123
}

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

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

0 commit comments

Comments
 (0)