src/tools/clippy/tests/ui/doc.rs

   1 //! This file tests for the `DOC_MARKDOWN` lint.
   2
   3 #![allow(dead_code)]
   4 #![warn(clippy::doc_markdown)]
   5 #![feature(custom_inner_attributes)]
   6 #![rustfmt::skip]
   7
   8 /// The foo_bar function does _nothing_. See also foo::bar. (note the dot there)
   9 /// Markdown is _weird_. I mean _really weird_. This \_ is ok. So is `_`. But not Foo::some_fun
  10 /// which should be reported only once despite being __doubly bad__.
  11 /// Here be ::a::global:path.
  12 /// That's not code ~NotInCodeBlock~.
  13 /// be_sure_we_got_to_the_end_of_it
  14 fn foo_bar() {
  15 }
  16
  17 /// That one tests multiline ticks.
  18 /// ```rust
  19 /// foo_bar FOO_BAR
  20 /// _foo bar_
  21 /// ```
  22 ///
  23 /// ~~~rust
  24 /// foo_bar FOO_BAR
  25 /// _foo bar_
  26 /// ~~~
  27 /// be_sure_we_got_to_the_end_of_it
  28 fn multiline_codeblock() {
  29 }
  30
  31 /// This _is a test for
  32 /// multiline
  33 /// emphasis_.
  34 /// be_sure_we_got_to_the_end_of_it
  35 fn test_emphasis() {
  36 }
  37
  38 /// This tests units. See also #835.
  39 /// kiB MiB GiB TiB PiB EiB
  40 /// kib Mib Gib Tib Pib Eib
  41 /// kB MB GB TB PB EB
  42 /// kb Mb Gb Tb Pb Eb
  43 /// 32kiB 32MiB 32GiB 32TiB 32PiB 32EiB
  44 /// 32kib 32Mib 32Gib 32Tib 32Pib 32Eib
  45 /// 32kB 32MB 32GB 32TB 32PB 32EB
  46 /// 32kb 32Mb 32Gb 32Tb 32Pb 32Eb
  47 /// NaN
  48 /// be_sure_we_got_to_the_end_of_it
  49 fn test_units() {
  50 }
  51
  52 /// This tests allowed identifiers.
  53 /// DirectX
  54 /// ECMAScript
  55 /// OAuth GraphQL
  56 /// TeX LaTeX BibTeX BibLaTeX
  57 /// CamelCase (see also #2395)
  58 /// be_sure_we_got_to_the_end_of_it
  59 fn test_allowed() {
  60 }
  61
  62 /// This test has [a link_with_underscores][chunked-example] inside it. See #823.
  63 /// See also [the issue tracker](https://github.com/rust-lang/rust-clippy/search?q=clippy::doc_markdown&type=Issues)
  64 /// on GitHub (which is a camel-cased word, but is OK). And here is another [inline link][inline_link].
  65 /// It can also be [inline_link2].
  66 ///
  67 /// [chunked-example]: https://en.wikipedia.org/wiki/Chunked_transfer_encoding#Example
  68 /// [inline_link]: https://foobar
  69 /// [inline_link2]: https://foobar
  70 /// The `main` function is the entry point of the program. Here it only calls the `foo_bar` and
  71 /// `multiline_ticks` functions.
  72 ///
  73 /// expression of the type  `_ <bit_op> m <cmp_op> c` (where `<bit_op>`
  74 /// is one of {`&`, '|'} and `<cmp_op>` is one of {`!=`, `>=`, `>` ,
  75 /// be_sure_we_got_to_the_end_of_it
  76 fn main() {
  77     foo_bar();
  78     multiline_codeblock();
  79     test_emphasis();
  80     test_units();
  81 }
  82
  83 /// ## CamelCaseThing
  84 /// Talks about `CamelCaseThing`. Titles should be ignored; see issue #897.
  85 ///
  86 /// # CamelCaseThing
  87 ///
  88 /// Not a title #897 CamelCaseThing
  89 /// be_sure_we_got_to_the_end_of_it
  90 fn issue897() {
  91 }
  92
  93 /// I am confused by brackets? (`x_y`)
  94 /// I am confused by brackets? (foo `x_y`)
  95 /// I am confused by brackets? (`x_y` foo)
  96 /// be_sure_we_got_to_the_end_of_it
  97 fn issue900() {
  98 }
  99
 100 /// Diesel queries also have a similar problem to [Iterator][iterator], where
 101 /// /// More talking
 102 /// returning them from a function requires exposing the implementation of that
 103 /// function. The [`helper_types`][helper_types] module exists to help with this,
 104 /// but you might want to hide the return type or have it conditionally change.
 105 /// Boxing can achieve both.
 106 ///
 107 /// [iterator]: https://doc.rust-lang.org/stable/std/iter/trait.Iterator.html
 108 /// [helper_types]: ../helper_types/index.html
 109 /// be_sure_we_got_to_the_end_of_it
 110 fn issue883() {
 111 }
 112
 113 /// `foo_bar
 114 /// baz_quz`
 115 /// [foo
 116 /// bar](https://doc.rust-lang.org/stable/std/iter/trait.IteratorFooBar.html)
 117 fn multiline() {
 118 }
 119
 120 /** E.g., serialization of an empty list: FooBar
 121 ```
 122 That's in a code block: `PackedNode`
 123 ```
 124
 125 And BarQuz too.
 126 be_sure_we_got_to_the_end_of_it
 127 */
 128 fn issue1073() {
 129 }
 130
 131 /** E.g., serialization of an empty list: FooBar
 132 ```
 133 That's in a code block: PackedNode
 134 ```
 135
 136 And BarQuz too.
 137 be_sure_we_got_to_the_end_of_it
 138 */
 139 fn issue1073_alt() {
 140 }
 141
 142 /// Tests more than three quotes:
 143 /// ````
 144 /// DoNotWarn
 145 /// ```
 146 /// StillDont
 147 /// ````
 148 /// be_sure_we_got_to_the_end_of_it
 149 fn four_quotes() {
 150 }
 151
 152 /// See [NIST SP 800-56A, revision 2].
 153 ///
 154 /// [NIST SP 800-56A, revision 2]:
 155 ///     https://github.com/rust-lang/rust-clippy/issues/902#issuecomment-261919419
 156 fn issue_902_comment() {}
 157
 158 #[cfg_attr(feature = "a", doc = " ```")]
 159 #[cfg_attr(not(feature = "a"), doc = " ```ignore")]
 160 /// fn main() {
 161 ///     let s = "localhost:10000".to_string();
 162 ///     println!("{}", s);
 163 /// }
 164 /// ```
 165 fn issue_1469() {}
 166
 167 /**
 168  * This is a doc comment that should not be a list
 169  *This would also be an error under a strict common mark interpretation
 170  */
 171 fn issue_1920() {}
 172
 173 /// Ok: <http://www.unicode.org/reports/tr9/#Reordering_Resolved_Levels>
 174 ///
 175 /// Not ok: http://www.unicode.org
 176 /// Not ok: https://www.unicode.org
 177 /// Not ok: http://www.unicode.org/
 178 /// Not ok: http://www.unicode.org/reports/tr9/#Reordering_Resolved_Levels
 179 fn issue_1832() {}
 180
 181 /// An iterator over mycrate::Collection's values.
 182 /// It should not lint a `'static` lifetime in ticks.
 183 fn issue_2210() {}
 184
 185 /// This should not cause the lint to trigger:
 186 /// #REQ-data-family.lint_partof_exists
 187 fn issue_2343() {}
 188
 189 /// This should not cause an ICE:
 190 /// __|_ _|__||_|
 191 fn pulldown_cmark_crash() {}