crates/ide/src/syntax_highlighting/test_data/highlight_doctest.html

   1
   2 <style>
   3 body                { margin: 0; }
   4 pre                 { color: #DCDCCC; background: #3F3F3F; font-size: 22px; padding: 0.4em; }
   5
   6 .lifetime           { color: #DFAF8F; font-style: italic; }
   7 .label              { color: #DFAF8F; font-style: italic; }
   8 .comment            { color: #7F9F7F; }
   9 .documentation      { color: #629755; }
  10 .intra_doc_link     { font-style: italic; }
  11 .injected           { opacity: 0.65 ; }
  12 .struct, .enum      { color: #7CB8BB; }
  13 .enum_variant       { color: #BDE0F3; }
  14 .string_literal     { color: #CC9393; }
  15 .field              { color: #94BFF3; }
  16 .function           { color: #93E0E3; }
  17 .function.unsafe    { color: #BC8383; }
  18 .trait.unsafe       { color: #BC8383; }
  19 .operator.unsafe    { color: #BC8383; }
  20 .parameter          { color: #94BFF3; }
  21 .text               { color: #DCDCCC; }
  22 .type               { color: #7CB8BB; }
  23 .builtin_type       { color: #8CD0D3; }
  24 .type_param         { color: #DFAF8F; }
  25 .attribute          { color: #94BFF3; }
  26 .numeric_literal    { color: #BFEBBF; }
  27 .bool_literal       { color: #BFE6EB; }
  28 .macro              { color: #94BFF3; }
  29 .module             { color: #AFD8AF; }
  30 .value_param        { color: #DCDCCC; }
  31 .variable           { color: #DCDCCC; }
  32 .format_specifier   { color: #CC696B; }
  33 .mutable            { text-decoration: underline; }
  34 .escape_sequence    { color: #94BFF3; }
  35 .keyword            { color: #F0DFAF; font-weight: bold; }
  36 .keyword.unsafe     { color: #BC8383; font-weight: bold; }
  37 .control            { font-style: italic; }
  38
  39 .unresolved_reference { color: #FC5555; text-decoration: wavy underline; }
  40 </style>
  41 <pre><code><span class="comment documentation">//! This is a module to test doc injection.</span>
  42 <span class="comment documentation">//! ```</span>
  43 <span class="comment documentation">//! </span><span class="keyword injected">fn</span><span class="none injected"> </span><span class="function declaration injected">test</span><span class="parenthesis injected">(</span><span class="parenthesis injected">)</span><span class="none injected"> </span><span class="brace injected">{</span><span class="brace injected">}</span>
  44 <span class="comment documentation">//! ```</span>
  45
  46 <span class="comment documentation">/// ```</span>
  47 <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="none injected"> </span><span class="punctuation injected">_</span><span class="none injected"> </span><span class="operator injected">=</span><span class="none injected"> </span><span class="string_literal injected">"early doctests should not go boom"</span><span class="semicolon injected">;</span>
  48 <span class="comment documentation">/// ```</span>
  49 <span class="keyword">struct</span> <span class="struct declaration">Foo</span> <span class="brace">{</span>
  50     <span class="field declaration">bar</span><span class="colon">:</span> <span class="builtin_type">bool</span><span class="comma">,</span>
  51 <span class="brace">}</span>
  52
  53 <span class="comment documentation">/// This is an impl with a code block.</span>
  54 <span class="comment documentation">///</span>
  55 <span class="comment documentation">/// ```</span>
  56 <span class="comment documentation">/// </span><span class="keyword injected">fn</span><span class="none injected"> </span><span class="function declaration injected">foo</span><span class="parenthesis injected">(</span><span class="parenthesis injected">)</span><span class="none injected"> </span><span class="brace injected">{</span>
  57 <span class="comment documentation">///</span>
  58 <span class="comment documentation">/// </span><span class="brace injected">}</span>
  59 <span class="comment documentation">/// ```</span>
  60 <span class="keyword">impl</span> <span class="struct">Foo</span> <span class="brace">{</span>
  61     <span class="comment documentation">/// ```</span>
  62     <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="none injected"> </span><span class="punctuation injected">_</span><span class="none injected"> </span><span class="operator injected">=</span><span class="none injected"> </span><span class="string_literal injected">"Call me</span>
  63     <span class="comment">//    KILLER WHALE</span>
  64     <span class="comment documentation">/// </span><span class="string_literal injected">    Ishmael."</span><span class="semicolon injected">;</span>
  65     <span class="comment documentation">/// ```</span>
  66     <span class="keyword">pub</span> <span class="keyword">const</span> <span class="constant associated declaration public">bar</span><span class="colon">:</span> <span class="builtin_type">bool</span> <span class="operator">=</span> <span class="bool_literal">true</span><span class="semicolon">;</span>
  67
  68     <span class="comment documentation">/// Constructs a new `Foo`.</span>
  69     <span class="comment documentation">///</span>
  70     <span class="comment documentation">/// # Examples</span>
  71     <span class="comment documentation">///</span>
  72     <span class="comment documentation">/// ```</span>
  73     <span class="comment documentation">/// #</span><span class="none injected"> </span><span class="attribute attribute injected">#</span><span class="attribute attribute injected">!</span><span class="attribute attribute injected">[</span><span class="function attribute injected">allow</span><span class="parenthesis attribute injected">(</span><span class="attribute attribute injected">unused_mut</span><span class="parenthesis attribute injected">)</span><span class="attribute attribute injected">]</span>
  74     <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="none injected"> </span><span class="keyword injected">mut</span><span class="none injected"> </span><span class="variable declaration injected mutable">foo</span><span class="colon injected">:</span><span class="none injected"> </span><span class="struct injected">Foo</span><span class="none injected"> </span><span class="operator injected">=</span><span class="none injected"> </span><span class="struct injected">Foo</span><span class="operator injected">::</span><span class="function injected">new</span><span class="parenthesis injected">(</span><span class="parenthesis injected">)</span><span class="semicolon injected">;</span>
  75     <span class="comment documentation">/// ```</span>
  76     <span class="keyword">pub</span> <span class="keyword">const</span> <span class="keyword">fn</span> <span class="function associated declaration static public">new</span><span class="parenthesis">(</span><span class="parenthesis">)</span> <span class="operator">-&gt;</span> <span class="struct">Foo</span> <span class="brace">{</span>
  77         <span class="struct">Foo</span> <span class="brace">{</span> <span class="field">bar</span><span class="colon">:</span> <span class="bool_literal">true</span> <span class="brace">}</span>
  78     <span class="brace">}</span>
  79
  80     <span class="comment documentation">/// `bar` method on `Foo`.</span>
  81     <span class="comment documentation">///</span>
  82     <span class="comment documentation">/// # Examples</span>
  83     <span class="comment documentation">///</span>
  84     <span class="comment documentation">/// ```</span>
  85     <span class="comment documentation">/// </span><span class="keyword injected">use</span><span class="none injected"> </span><span class="module injected">x</span><span class="operator injected">::</span><span class="module injected">y</span><span class="semicolon injected">;</span>
  86     <span class="comment documentation">///</span>
  87     <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="none injected"> </span><span class="variable declaration injected">foo</span><span class="none injected"> </span><span class="operator injected">=</span><span class="none injected"> </span><span class="struct injected">Foo</span><span class="operator injected">::</span><span class="function injected">new</span><span class="parenthesis injected">(</span><span class="parenthesis injected">)</span><span class="semicolon injected">;</span>
  88     <span class="comment documentation">///</span>
  89     <span class="comment documentation">/// </span><span class="comment injected">// calls bar on foo</span>
  90     <span class="comment documentation">/// </span><span class="macro injected">assert!</span><span class="parenthesis injected">(</span><span class="none injected">foo</span><span class="operator injected">.</span><span class="none injected">bar</span><span class="parenthesis injected">(</span><span class="parenthesis injected">)</span><span class="parenthesis injected">)</span><span class="semicolon injected">;</span>
  91     <span class="comment documentation">///</span>
  92     <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="none injected"> </span><span class="variable declaration injected">bar</span><span class="none injected"> </span><span class="operator injected">=</span><span class="none injected"> </span><span class="variable injected">foo</span><span class="operator injected">.</span><span class="field injected">bar</span><span class="none injected"> </span><span class="logical injected">||</span><span class="none injected"> </span><span class="struct injected">Foo</span><span class="operator injected">::</span><span class="constant injected">bar</span><span class="semicolon injected">;</span>
  93     <span class="comment documentation">///</span>
  94     <span class="comment documentation">/// </span><span class="comment injected">/* multi-line</span>
  95     <span class="comment documentation">/// </span><span class="comment injected">       comment */</span>
  96     <span class="comment documentation">///</span>
  97     <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="none injected"> </span><span class="variable declaration injected">multi_line_string</span><span class="none injected"> </span><span class="operator injected">=</span><span class="none injected"> </span><span class="string_literal injected">"Foo</span>
  98     <span class="comment documentation">/// </span><span class="string_literal injected">  bar</span><span class="escape_sequence injected">\n</span>
  99     <span class="comment documentation">/// </span><span class="string_literal injected">         "</span><span class="semicolon injected">;</span>
 100     <span class="comment documentation">///</span>
 101     <span class="comment documentation">/// ```</span>
 102     <span class="comment documentation">///</span>
 103     <span class="comment documentation">/// ```rust,no_run</span>
 104     <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="none injected"> </span><span class="variable declaration injected">foobar</span><span class="none injected"> </span><span class="operator injected">=</span><span class="none injected"> </span><span class="struct injected">Foo</span><span class="operator injected">::</span><span class="function injected">new</span><span class="parenthesis injected">(</span><span class="parenthesis injected">)</span><span class="operator injected">.</span><span class="function injected">bar</span><span class="parenthesis injected">(</span><span class="parenthesis injected">)</span><span class="semicolon injected">;</span>
 105     <span class="comment documentation">/// ```</span>
 106     <span class="comment documentation">///</span>
 107     <span class="comment documentation">/// ```sh</span>
 108     <span class="comment documentation">/// echo 1</span>
 109     <span class="comment documentation">/// ```</span>
 110     <span class="keyword">pub</span> <span class="keyword">fn</span> <span class="function associated declaration public">foo</span><span class="parenthesis">(</span><span class="operator">&</span><span class="self_keyword declaration">self</span><span class="parenthesis">)</span> <span class="operator">-&gt;</span> <span class="builtin_type">bool</span> <span class="brace">{</span>
 111         <span class="bool_literal">true</span>
 112     <span class="brace">}</span>
 113 <span class="brace">}</span>
 114
 115 <span class="comment documentation">/// </span><span class="struct documentation injected intra_doc_link">[`Foo`](Foo)</span><span class="comment documentation"> is a struct</span>
 116 <span class="comment documentation">/// This function is &gt; </span><span class="function documentation injected intra_doc_link">[`all_the_links`](all_the_links)</span><span class="comment documentation"> &lt;</span>
 117 <span class="comment documentation">/// [`noop`](noop) is a macro below</span>
 118 <span class="comment documentation">/// </span><span class="struct documentation injected intra_doc_link">[`Item`]</span><span class="comment documentation"> is a struct in the module </span><span class="module documentation injected intra_doc_link">[`module`]</span>
 119 <span class="comment documentation">///</span>
 120 <span class="comment documentation">/// [`Item`]: module::Item</span>
 121 <span class="comment documentation">/// [mix_and_match]: ThisShouldntResolve</span>
 122 <span class="keyword">pub</span> <span class="keyword">fn</span> <span class="function declaration public">all_the_links</span><span class="parenthesis">(</span><span class="parenthesis">)</span> <span class="brace">{</span><span class="brace">}</span>
 123
 124 <span class="keyword">pub</span> <span class="keyword">mod</span> <span class="module declaration public">module</span> <span class="brace">{</span>
 125     <span class="keyword">pub</span> <span class="keyword">struct</span> <span class="struct declaration public">Item</span><span class="semicolon">;</span>
 126 <span class="brace">}</span>
 127
 128 <span class="comment documentation">/// ```</span>
 129 <span class="comment documentation">/// </span><span class="macro injected">noop!</span><span class="parenthesis injected">(</span><span class="numeric_literal injected">1</span><span class="parenthesis injected">)</span><span class="semicolon injected">;</span>
 130 <span class="comment documentation">/// ```</span>
 131 <span class="keyword">macro_rules</span><span class="punctuation">!</span> <span class="macro declaration">noop</span> <span class="brace">{</span>
 132     <span class="parenthesis">(</span><span class="punctuation">$</span>expr<span class="colon">:</span>expr<span class="parenthesis">)</span> <span class="operator">=</span><span class="angle">&gt;</span> <span class="brace">{</span>
 133         <span class="punctuation">$</span>expr
 134     <span class="brace">}</span>
 135 <span class="brace">}</span>
 136
 137 <span class="comment documentation">/// ```rust</span>
 138 <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="none injected"> </span><span class="punctuation injected">_</span><span class="none injected"> </span><span class="operator injected">=</span><span class="none injected"> </span><span class="function injected">example</span><span class="parenthesis injected">(</span><span class="operator injected">&</span><span class="bracket injected">[</span><span class="numeric_literal injected">1</span><span class="comma injected">,</span><span class="none injected"> </span><span class="numeric_literal injected">2</span><span class="comma injected">,</span><span class="none injected"> </span><span class="numeric_literal injected">3</span><span class="bracket injected">]</span><span class="parenthesis injected">)</span><span class="semicolon injected">;</span>
 139 <span class="comment documentation">/// ```</span>
 140 <span class="comment documentation">///</span>
 141 <span class="comment documentation">/// ```</span>
 142 <span class="comment documentation">/// </span><span class="keyword control injected">loop</span><span class="none injected"> </span><span class="brace injected">{</span><span class="brace injected">}</span>
 143 <span class="attribute attribute">#</span><span class="attribute attribute">[</span><span class="function attribute">cfg_attr</span><span class="parenthesis attribute">(</span><span class="attribute attribute">not</span><span class="parenthesis attribute">(</span><span class="attribute attribute">feature </span><span class="operator attribute">=</span><span class="attribute attribute"> </span><span class="string_literal attribute">"false"</span><span class="parenthesis attribute">)</span><span class="comma attribute">,</span><span class="attribute attribute"> doc </span><span class="operator attribute">=</span><span class="attribute attribute"> </span><span class="string_literal attribute">"</span><span class="keyword control injected">loop</span><span class="none injected"> </span><span class="brace injected">{</span><span class="brace injected">}</span><span class="string_literal attribute">"</span><span class="parenthesis attribute">)</span><span class="attribute attribute">]</span>
 144 <span class="attribute attribute">#</span><span class="attribute attribute">[</span><span class="function attribute">doc</span><span class="attribute attribute"> </span><span class="operator attribute">=</span><span class="attribute attribute"> </span><span class="string_literal attribute">"</span><span class="keyword control injected">loop</span><span class="none injected"> </span><span class="brace injected">{</span><span class="brace injected">}</span><span class="string_literal attribute">"</span><span class="attribute attribute">]</span>
 145 <span class="comment documentation">/// ```</span>
 146 <span class="comment documentation">///</span>
 147 <span class="attribute attribute">#</span><span class="attribute attribute">[</span><span class="function attribute">cfg_attr</span><span class="parenthesis attribute">(</span><span class="attribute attribute">feature </span><span class="operator attribute">=</span><span class="attribute attribute"> </span><span class="string_literal attribute">"alloc"</span><span class="comma attribute">,</span><span class="attribute attribute"> doc </span><span class="operator attribute">=</span><span class="attribute attribute"> </span><span class="string_literal attribute">"```rust"</span><span class="parenthesis attribute">)</span><span class="attribute attribute">]</span>
 148 <span class="attribute attribute">#</span><span class="attribute attribute">[</span><span class="function attribute">cfg_attr</span><span class="parenthesis attribute">(</span><span class="attribute attribute">not</span><span class="parenthesis attribute">(</span><span class="attribute attribute">feature </span><span class="operator attribute">=</span><span class="attribute attribute"> </span><span class="string_literal attribute">"alloc"</span><span class="parenthesis attribute">)</span><span class="comma attribute">,</span><span class="attribute attribute"> doc </span><span class="operator attribute">=</span><span class="attribute attribute"> </span><span class="string_literal attribute">"```ignore"</span><span class="parenthesis attribute">)</span><span class="attribute attribute">]</span>
 149 <span class="comment documentation">/// </span><span class="keyword injected">let</span><span class="none injected"> </span><span class="punctuation injected">_</span><span class="none injected"> </span><span class="operator injected">=</span><span class="none injected"> </span><span class="function injected">example</span><span class="parenthesis injected">(</span><span class="operator injected">&</span><span class="none injected">alloc::</span><span class="macro injected">vec!</span><span class="bracket injected">[</span><span class="numeric_literal injected">1</span><span class="comma injected">,</span><span class="none injected"> </span><span class="numeric_literal injected">2</span><span class="comma injected">,</span><span class="none injected"> </span><span class="numeric_literal injected">3</span><span class="bracket injected">]</span><span class="parenthesis injected">)</span><span class="semicolon injected">;</span>
 150 <span class="comment documentation">/// ```</span>
 151 <span class="keyword">pub</span> <span class="keyword">fn</span> <span class="function declaration public">mix_and_match</span><span class="parenthesis">(</span><span class="parenthesis">)</span> <span class="brace">{</span><span class="brace">}</span>
 152
 153 <span class="comment documentation">/**
 154 It is beyond me why you'd use these when you got ///
 155 ```rust
 156 </span><span class="keyword injected">let</span><span class="none injected"> </span><span class="punctuation injected">_</span><span class="none injected"> </span><span class="operator injected">=</span><span class="none injected"> </span><span class="function injected">example</span><span class="parenthesis injected">(</span><span class="operator injected">&</span><span class="bracket injected">[</span><span class="numeric_literal injected">1</span><span class="comma injected">,</span><span class="none injected"> </span><span class="numeric_literal injected">2</span><span class="comma injected">,</span><span class="none injected"> </span><span class="numeric_literal injected">3</span><span class="bracket injected">]</span><span class="parenthesis injected">)</span><span class="semicolon injected">;</span><span class="comment documentation">
 157 ```
 158 </span><span class="function documentation injected intra_doc_link">[`block_comments2`]</span><span class="comment documentation"> tests these with indentation
 159  */</span>
 160 <span class="keyword">pub</span> <span class="keyword">fn</span> <span class="function declaration public">block_comments</span><span class="parenthesis">(</span><span class="parenthesis">)</span> <span class="brace">{</span><span class="brace">}</span>
 161
 162 <span class="comment documentation">/**
 163     Really, I don't get it
 164     ```rust
 165 </span><span class="comment documentation"> </span><span class="none injected">   </span><span class="keyword injected">let</span><span class="none injected"> </span><span class="punctuation injected">_</span><span class="none injected"> </span><span class="operator injected">=</span><span class="none injected"> </span><span class="function injected">example</span><span class="parenthesis injected">(</span><span class="operator injected">&</span><span class="bracket injected">[</span><span class="numeric_literal injected">1</span><span class="comma injected">,</span><span class="none injected"> </span><span class="numeric_literal injected">2</span><span class="comma injected">,</span><span class="none injected"> </span><span class="numeric_literal injected">3</span><span class="bracket injected">]</span><span class="parenthesis injected">)</span><span class="semicolon injected">;</span><span class="comment documentation">
 166     ```
 167     </span><span class="function documentation injected intra_doc_link">[`block_comments`]</span><span class="comment documentation"> tests these without indentation
 168 */</span>
 169 <span class="keyword">pub</span> <span class="keyword">fn</span> <span class="function declaration public">block_comments2</span><span class="parenthesis">(</span><span class="parenthesis">)</span> <span class="brace">{</span><span class="brace">}</span></code></pre>