Skip to content

Commit a951108

Browse files
committed
Ensure all existing doctest code highlights have documentation modifier
1 parent aae26bc commit a951108

File tree

3 files changed

+22
-21
lines changed

3 files changed

+22
-21
lines changed

crates/ra_ide/src/snapshots/highlight_doctest.html

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,8 @@
4343
<span class="comment documentation">/// # Examples</span>
4444
<span class="comment documentation">///</span>
4545
<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>();
46+
<span class="comment documentation">/// #</span> <span class="attribute documentation">#![</span><span class="function attribute documentation">allow</span><span class="attribute documentation">(unused_mut)]</span>
47+
<span class="comment documentation">/// </span><span class="keyword documentation">let</span> <span class="keyword documentation">mut</span> <span class="variable declaration documentation mutable">foo</span>: <span class="struct documentation">Foo</span> = <span class="struct documentation">Foo</span>::<span class="function documentation">new</span>();
4848
<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> }
@@ -55,26 +55,26 @@
5555
<span class="comment documentation">/// # Examples</span>
5656
<span class="comment documentation">///</span>
5757
<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>;
58+
<span class="comment documentation">/// </span><span class="keyword documentation">use</span> <span class="module documentation">x</span>::<span class="module documentation">y</span>;
5959
<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>();
60+
<span class="comment documentation">/// </span><span class="keyword documentation">let</span> <span class="variable declaration documentation">foo</span> = <span class="struct documentation">Foo</span>::<span class="function documentation">new</span>();
6161
<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());
62+
<span class="comment documentation">/// </span><span class="comment documentation">// calls bar on foo</span>
63+
<span class="comment documentation">/// </span><span class="macro documentation">assert!</span>(foo.bar());
6464
<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>;
65+
<span class="comment documentation">/// </span><span class="keyword documentation">let</span> <span class="variable declaration documentation">bar</span> = <span class="variable documentation">foo</span>.<span class="field documentation">bar</span> || <span class="struct documentation">Foo</span>::<span class="constant documentation">bar</span>;
6666
<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>
67+
<span class="comment documentation">/// </span><span class="comment documentation">/* multi-line
68+
</span><span class="comment documentation">/// </span><span class="comment documentation"> comment */</span>
6969
<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>;
70+
<span class="comment documentation">/// </span><span class="keyword documentation">let</span> <span class="variable declaration documentation">multi_line_string</span> = <span class="string_literal documentation">"Foo
71+
</span><span class="comment documentation">/// </span><span class="string_literal documentation"> bar
72+
</span><span class="comment documentation">/// </span><span class="string_literal documentation"> "</span>;
7373
<span class="comment documentation">///</span>
7474
<span class="comment documentation">/// ```</span>
7575
<span class="comment documentation">///</span>
7676
<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>();
77+
<span class="comment documentation">/// </span><span class="keyword documentation">let</span> <span class="variable declaration documentation">foobar</span> = <span class="struct documentation">Foo</span>::<span class="function documentation">new</span>().<span class="function documentation">bar</span>();
7878
<span class="comment documentation">/// ```</span>
7979
<span class="comment documentation">///</span>
8080
<span class="comment documentation">/// ```sh</span>

crates/ra_ide/src/syntax_highlighting.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -477,10 +477,10 @@ fn highlight_element(
477477
// Simple token-based highlighting
478478
COMMENT => {
479479
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()
480+
let h = HighlightTag::Comment;
481+
match comment.kind().doc {
482+
Some(_) => h | HighlightModifier::Documentation,
483+
None => h.into(),
484484
}
485485
}
486486
STRING | RAW_STRING | RAW_BYTE_STRING | BYTE_STRING => HighlightTag::StringLiteral.into(),

crates/ra_ide/src/syntax_highlighting/injection.rs

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ use ra_syntax::{ast, AstToken, SyntaxNode, SyntaxToken, TextRange, TextSize};
88
use stdx::SepBy;
99

1010
use crate::{
11-
call_info::ActiveParameter, Analysis, Highlight, HighlightModifier, HighlightTag,
12-
HighlightedRange, RootDatabase,
11+
call_info::ActiveParameter, Analysis, HighlightModifier, HighlightTag, HighlightedRange,
12+
RootDatabase,
1313
};
1414

1515
use super::HighlightedRangeStack;
@@ -121,8 +121,7 @@ pub(super) fn extract_doc_comments(
121121
range.start(),
122122
range.start() + TextSize::try_from(pos).unwrap(),
123123
),
124-
highlight: Highlight::from(HighlightTag::Comment)
125-
| HighlightModifier::Documentation,
124+
highlight: HighlightTag::Comment | HighlightModifier::Documentation,
126125
binding_hash: None,
127126
});
128127
line_start += range.len() - TextSize::try_from(pos).unwrap();
@@ -168,6 +167,8 @@ pub(super) fn highlight_doc_comment(
168167
h.range.start() + start_offset,
169168
h.range.end() + end_offset.unwrap_or(start_offset),
170169
);
170+
171+
h.highlight |= HighlightModifier::Documentation;
171172
stack.add(h);
172173
}
173174
}

0 commit comments

Comments
 (0)