aboutsummaryrefslogtreecommitdiff
path: root/crates/ra_ide/src/snapshots/highlight_doctest.html
blob: 6b3932aff2d6156c0f46f9904500192fd95b1d8c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
<style>
body                { margin: 0; }
pre                 { color: #DCDCCC; background: #3F3F3F; font-size: 22px; padding: 0.4em; }

.lifetime           { color: #DFAF8F; font-style: italic; }
.comment            { color: #7F9F7F; }
.struct, .enum      { color: #7CB8BB; }
.enum_variant       { color: #BDE0F3; }
.string_literal     { color: #CC9393; }
.field              { color: #94BFF3; }
.function           { color: #93E0E3; }
.function.unsafe    { color: #BC8383; }
.operator.unsafe    { color: #BC8383; }
.parameter          { color: #94BFF3; }
.text               { color: #DCDCCC; }
.type               { color: #7CB8BB; }
.builtin_type       { color: #8CD0D3; }
.type_param         { color: #DFAF8F; }
.attribute          { color: #94BFF3; }
.numeric_literal    { color: #BFEBBF; }
.bool_literal       { color: #BFE6EB; }
.macro              { color: #94BFF3; }
.module             { color: #AFD8AF; }
.variable           { color: #DCDCCC; }
.format_specifier   { color: #CC696B; }
.mutable            { text-decoration: underline; }
.unresolved_reference { color: #FC5555; }
.escape_sequence    { color: #94BFF3; }

.keyword            { color: #F0DFAF; font-weight: bold; }
.keyword.unsafe     { color: #BC8383; font-weight: bold; }
.control            { font-style: italic; }
</style>
<pre><code><span class="comment documentation">/// ```</span>
<span class="comment documentation">/// </span><span class="keyword">let</span> _ = <span class="string_literal">"early doctests should not go boom"</span>;
<span class="comment documentation">/// ```</span>
<span class="keyword">struct</span> <span class="struct declaration">Foo</span> {
    <span class="field declaration">bar</span>: <span class="builtin_type">bool</span>,
}

<span class="keyword">impl</span> <span class="struct">Foo</span> {
    <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>;

    <span class="comment documentation">/// Constructs a new `Foo`.</span>
    <span class="comment documentation">///</span>
    <span class="comment documentation">/// # Examples</span>
    <span class="comment documentation">///</span>
    <span class="comment documentation">/// ```</span>
    <span class="comment documentation">/// #</span> <span class="operator injected">#</span><span class="operator injected">!</span><span class="operator injected">[</span><span class="operator injected">allow</span><span class="operator injected">(</span><span class="operator injected">unused_mut</span><span class="operator injected">)</span><span class="operator injected">]</span><span class="operator injected">
</span>    <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="operator injected"> </span><span class="keyword injected">mut</span><span class="operator injected"> </span><span class="operator injected">foo</span><span class="operator injected">:</span><span class="operator injected"> </span><span class="operator injected">Foo</span><span class="operator injected"> </span><span class="operator injected">=</span><span class="operator injected"> </span><span class="operator injected">Foo</span><span class="operator injected">::</span><span class="operator injected">new</span><span class="operator injected">(</span><span class="operator injected">)</span><span class="operator injected">;</span><span class="operator injected">
</span><span class="operator injected"> </span>   <span class="comment documentation">/// ```</span>
    <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> {
        <span class="struct">Foo</span> { <span class="field">bar</span>: <span class="bool_literal">true</span> }
    }

    <span class="comment documentation">/// `bar` method on `Foo`.</span>
    <span class="comment documentation">///</span>
    <span class="comment documentation">/// # Examples</span>
    <span class="comment documentation">///</span>
    <span class="comment documentation">/// ```</span>
    <span class="comment documentation">/// </span><span class="keyword injected">use</span><span class="operator injected"> </span><span class="operator injected">x</span><span class="operator injected">::</span><span class="operator injected">y</span><span class="operator injected">;</span><span class="operator injected">
    </span><span class="comment documentation">///</span><span class="operator injected">
</span>    <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="operator injected"> </span><span class="operator injected">foo</span><span class="operator injected"> </span><span class="operator injected">=</span><span class="operator injected"> </span><span class="operator injected">Foo</span><span class="operator injected">::</span><span class="operator injected">new</span><span class="operator injected">(</span><span class="operator injected">)</span><span class="operator injected">;</span><span class="operator injected">
    </span><span class="comment documentation">///</span><span class="operator injected">
</span>    <span class="comment documentation">/// </span><span class="comment injected">// calls bar on foo</span><span class="operator injected">
</span>    <span class="comment documentation">/// </span><span class="macro injected">assert!</span><span class="operator injected">(</span><span class="operator injected">foo</span><span class="operator injected">.</span><span class="operator injected">bar</span><span class="operator injected">(</span><span class="operator injected">)</span><span class="operator injected">)</span><span class="operator injected">;</span><span class="operator injected">
    </span><span class="comment documentation">///</span><span class="operator injected">
</span>    <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="operator injected"> </span><span class="operator injected">bar</span><span class="operator injected"> </span><span class="operator injected">=</span><span class="operator injected"> </span><span class="operator injected">foo</span><span class="operator injected">.</span><span class="operator injected">bar</span><span class="operator injected"> </span><span class="operator injected">||</span><span class="operator injected"> </span><span class="operator injected">Foo</span><span class="operator injected">::</span><span class="operator injected">bar</span><span class="operator injected">;</span><span class="operator injected">
    </span><span class="comment documentation">///</span><span class="operator injected">
</span>    <span class="comment documentation">/// </span><span class="comment injected">/* multi-line
    </span><span class="comment documentation">/// </span><span class="comment injected">       comment */</span><span class="operator injected">
    </span><span class="comment documentation">///</span><span class="operator injected">
</span>    <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="operator injected"> </span><span class="operator injected">multi_line_string</span><span class="operator injected"> </span><span class="operator injected">=</span><span class="operator injected"> </span><span class="string_literal injected">"Foo
    </span><span class="comment documentation">/// </span><span class="string_literal injected">  bar
    </span><span class="comment documentation">/// </span><span class="string_literal injected">         "</span><span class="operator injected">;</span><span class="operator injected">
    </span><span class="comment documentation">///</span><span class="operator injected">
</span>    <span class="comment documentation">/// ```</span>
    <span class="comment documentation">///</span>
    <span class="comment documentation">/// ```rust,no_run</span>
    <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="operator injected"> </span><span class="operator injected">foobar</span><span class="operator injected"> </span><span class="operator injected">=</span><span class="operator injected"> </span><span class="operator injected">Foo</span><span class="operator injected">::</span><span class="operator injected">new</span><span class="operator injected">(</span><span class="operator injected">)</span><span class="operator injected">.</span><span class="operator injected">bar</span><span class="operator injected">(</span><span class="operator injected">)</span><span class="operator injected">;</span><span class="operator injected">
</span><span class="operator injected"> </span>   <span class="comment documentation">/// ```</span>
    <span class="comment documentation">///</span>
    <span class="comment documentation">/// ```sh</span>
    <span class="comment documentation">/// echo 1</span>
    <span class="comment documentation">/// ```</span>
    <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> {
        <span class="bool_literal">true</span>
    }
}

<span class="comment documentation">/// ```</span>
<span class="comment documentation">/// </span><span class="macro">noop!</span>(<span class="numeric_literal">1</span>);
<span class="comment documentation">/// ```</span>
<span class="macro">macro_rules!</span> <span class="macro declaration">noop</span> {
    ($expr:expr) =&gt; {
        $expr
    }
}</code></pre>