Skip to content

Add doc(include = ...) detection to missing_docs_in_private_items #3883

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Mar 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 19 additions & 2 deletions clippy_lints/src/missing_doc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,12 @@
//

use crate::utils::{in_macro, span_lint};
use if_chain::if_chain;
use rustc::hir;
use rustc::lint::{LateContext, LateLintPass, LintArray, LintContext, LintPass};
use rustc::ty;
use rustc::{declare_tool_lint, lint_array};
use syntax::ast;
use syntax::ast::{self, MetaItem, MetaItemKind};
use syntax::attr;
use syntax::source_map::Span;

Expand Down Expand Up @@ -52,6 +53,20 @@ impl MissingDoc {
*self.doc_hidden_stack.last().expect("empty doc_hidden_stack")
}

fn has_include(meta: Option<MetaItem>) -> bool {
if_chain! {
if let Some(meta) = meta;
if let MetaItemKind::List(list) = meta.node;
if let Some(meta) = list.get(0);
if let Some(name) = meta.name();
then {
name == "include"
} else {
false
}
}
}

fn check_missing_docs_attrs(
&self,
cx: &LateContext<'_, '_>,
Expand All @@ -74,7 +89,9 @@ impl MissingDoc {
return;
}

let has_doc = attrs.iter().any(|a| a.is_value_str() && a.name() == "doc");
let has_doc = attrs
.iter()
.any(|a| a.name() == "doc" && (a.is_value_str() || Self::has_include(a.meta())));
if !has_doc {
span_lint(
cx,
Expand Down
3 changes: 3 additions & 0 deletions tests/ui/missing-doc-crate-missing.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#![warn(clippy::missing_docs_in_private_items)]

fn main() {}
12 changes: 12 additions & 0 deletions tests/ui/missing-doc-crate-missing.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
error: missing documentation for crate
--> $DIR/missing-doc-crate-missing.rs:1:1
|
LL | / #![warn(clippy::missing_docs_in_private_items)]
LL | |
LL | | fn main() {}
| |____________^
|
= note: `-D clippy::missing-docs-in-private-items` implied by `-D warnings`

error: aborting due to previous error

5 changes: 5 additions & 0 deletions tests/ui/missing-doc-crate.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
#![warn(clippy::missing_docs_in_private_items)]
#![feature(external_doc)]
#![doc(include = "../../README.md")]

fn main() {}
Empty file.