diff options
| author | Roman <romaaan.git@gmail.com> | 2020-09-01 14:19:24 +0200 |
|---|---|---|
| committer | Guillaume Gomez <guillaume1.gomez@gmail.com> | 2020-10-12 13:46:37 +0200 |
| commit | 02e6b861eb04737915636a63eec00ef126f59dd5 (patch) | |
| tree | 36e387b48a4e533f3976d591d4bd8b30ba3ddef4 /src/test/rustdoc-ui/coverage/allow_missing_docs.rs | |
| parent | 0e022fc2b8eecbc16c090a99efbbd262c37ec962 (diff) | |
| download | rust-02e6b861eb04737915636a63eec00ef126f59dd5.tar.gz rust-02e6b861eb04737915636a63eec00ef126f59dd5.zip | |
rustdoc: skip allow missing doc in cover. report
During the document coverage reporting with ```bash rustdoc something.rs -Z unstable-options --show-coverage ``` the coverage report also includes parts of the code that are marked with `#[allow(missing_docs)]`, which outputs lower numbers in the coverage report even though these parts should be ignored for the calculation. Co-authored-by: Joshua Nelson <joshua@yottadb.com>
Diffstat (limited to 'src/test/rustdoc-ui/coverage/allow_missing_docs.rs')
| -rw-r--r-- | src/test/rustdoc-ui/coverage/allow_missing_docs.rs | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/src/test/rustdoc-ui/coverage/allow_missing_docs.rs b/src/test/rustdoc-ui/coverage/allow_missing_docs.rs new file mode 100644 index 00000000000..8c076761ede --- /dev/null +++ b/src/test/rustdoc-ui/coverage/allow_missing_docs.rs @@ -0,0 +1,31 @@ +// compile-flags:-Z unstable-options --show-coverage +// check-pass + +//! Make sure to have some docs on your crate root + +#[allow(missing_docs)] +pub mod mod_foo { + pub struct Bar; +} + +/// This is a struct with a `#[allow(missing_docs)]` +pub struct AllowTheMissingDocs { + #[allow(missing_docs)] + pub empty_str: String, + + /// This has + #[allow(missing_docs)] + /// but also has documentation comments + pub hello: usize, + + /// The doc id just to create a boilerplate comment + pub doc_id: Vec<u8>, +} + +/// A function that has a documentation +pub fn this_is_func() {} + +#[allow(missing_docs)] +pub struct DemoStruct { + something: usize, +} |
