// *rustc*'s
// [`missing_doc`].
//
-// [`missing_doc`]: https://github.com/rust-lang/rust/blob/d6d05904697d89099b55da3331155392f1db9c00/src/librustc_lint/builtin.rs#L246
+// [`missing_doc`]: https://github.com/rust-lang/rust/blob/cf9cf7c923eb01146971429044f216a3ca905e06/compiler/rustc_lint/src/builtin.rs#L415
//
-use crate::utils::span_lint;
+use clippy_utils::attrs::is_doc_hidden;
+use clippy_utils::diagnostics::span_lint;
use if_chain::if_chain;
-use rustc::hir;
-use rustc::impl_lint_pass;
-use rustc::lint::{LateContext, LateLintPass, LintArray, LintContext, LintPass};
-use rustc::ty;
-use rustc_session::declare_tool_lint;
-use syntax::ast::{self, MetaItem, MetaItemKind};
-use syntax::attr;
-use syntax::source_map::Span;
+use rustc_ast::ast::{self, MetaItem, MetaItemKind};
+use rustc_hir as hir;
+use rustc_lint::{LateContext, LateLintPass, LintContext};
+use rustc_middle::ty;
+use rustc_session::{declare_tool_lint, impl_lint_pass};
+use rustc_span::source_map::Span;
+use rustc_span::sym;
declare_clippy_lint! {
/// **What it does:** Warns if there is missing doc for any documentable item
doc_hidden_stack: Vec<bool>,
}
-impl ::std::default::Default for MissingDoc {
+impl Default for MissingDoc {
#[must_use]
fn default() -> Self {
Self::new()
if let Some(meta) = list.get(0);
if let Some(name) = meta.ident();
then {
- name.as_str() == "include"
+ name.name == sym::include
} else {
false
}
fn check_missing_docs_attrs(
&self,
- cx: &LateContext<'_, '_>,
+ cx: &LateContext<'_>,
attrs: &[ast::Attribute],
sp: Span,
+ article: &'static str,
desc: &'static str,
) {
// If we're building a test harness, then warning about
return;
}
- let has_doc = attrs
- .iter()
- .any(|a| a.check_name(sym!(doc)) && (a.is_value_str() || Self::has_include(a.meta())));
+ let has_doc = attrs.iter().any(|a| {
+ a.is_doc_comment() || a.doc_str().is_some() || a.value_str().is_some() || Self::has_include(a.meta())
+ });
if !has_doc {
span_lint(
cx,
MISSING_DOCS_IN_PRIVATE_ITEMS,
sp,
- &format!("missing documentation for {}", desc),
+ &format!("missing documentation for {} {}", article, desc),
);
}
}
impl_lint_pass!(MissingDoc => [MISSING_DOCS_IN_PRIVATE_ITEMS]);
-impl<'a, 'tcx> LateLintPass<'a, 'tcx> for MissingDoc {
- fn enter_lint_attrs(&mut self, _: &LateContext<'a, 'tcx>, attrs: &'tcx [ast::Attribute]) {
- let doc_hidden = self.doc_hidden()
- || attrs.iter().any(|attr| {
- attr.check_name(sym!(doc))
- && match attr.meta_item_list() {
- None => false,
- Some(l) => attr::list_contains_name(&l[..], sym!(hidden)),
- }
- });
+impl<'tcx> LateLintPass<'tcx> for MissingDoc {
+ fn enter_lint_attrs(&mut self, _: &LateContext<'tcx>, attrs: &'tcx [ast::Attribute]) {
+ let doc_hidden = self.doc_hidden() || is_doc_hidden(attrs);
self.doc_hidden_stack.push(doc_hidden);
}
- fn exit_lint_attrs(&mut self, _: &LateContext<'a, 'tcx>, _: &'tcx [ast::Attribute]) {
+ fn exit_lint_attrs(&mut self, _: &LateContext<'tcx>, _: &'tcx [ast::Attribute]) {
self.doc_hidden_stack.pop().expect("empty doc_hidden_stack");
}
- fn check_crate(&mut self, cx: &LateContext<'a, 'tcx>, krate: &'tcx hir::Crate) {
- self.check_missing_docs_attrs(cx, &krate.attrs, krate.span, "crate");
+ fn check_crate(&mut self, cx: &LateContext<'tcx>, krate: &'tcx hir::Crate<'_>) {
+ let attrs = cx.tcx.hir().attrs(hir::CRATE_HIR_ID);
+ self.check_missing_docs_attrs(cx, attrs, krate.item.inner, "the", "crate");
}
- fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, it: &'tcx hir::Item) {
- let desc = match it.kind {
- hir::ItemKind::Const(..) => "a constant",
- hir::ItemKind::Enum(..) => "an enum",
+ fn check_item(&mut self, cx: &LateContext<'tcx>, it: &'tcx hir::Item<'_>) {
+ match it.kind {
hir::ItemKind::Fn(..) => {
// ignore main()
- if it.ident.name == sym!(main) {
- let def_id = cx.tcx.hir().local_def_id(it.hir_id);
- let def_key = cx.tcx.hir().def_key(def_id);
+ if it.ident.name == sym::main {
+ let def_key = cx.tcx.hir().def_key(it.def_id);
if def_key.parent == Some(hir::def_id::CRATE_DEF_INDEX) {
return;
}
}
- "a function"
},
- hir::ItemKind::Mod(..) => "a module",
- hir::ItemKind::Static(..) => "a static",
- hir::ItemKind::Struct(..) => "a struct",
- hir::ItemKind::Trait(..) => "a trait",
- hir::ItemKind::TraitAlias(..) => "a trait alias",
- hir::ItemKind::TyAlias(..) => "a type alias",
- hir::ItemKind::Union(..) => "a union",
- hir::ItemKind::OpaqueTy(..) => "an existential type",
+ hir::ItemKind::Const(..)
+ | hir::ItemKind::Enum(..)
+ | hir::ItemKind::Mod(..)
+ | hir::ItemKind::Static(..)
+ | hir::ItemKind::Struct(..)
+ | hir::ItemKind::Trait(..)
+ | hir::ItemKind::TraitAlias(..)
+ | hir::ItemKind::TyAlias(..)
+ | hir::ItemKind::Union(..)
+ | hir::ItemKind::OpaqueTy(..) => {},
hir::ItemKind::ExternCrate(..)
- | hir::ItemKind::ForeignMod(..)
+ | hir::ItemKind::ForeignMod { .. }
| hir::ItemKind::GlobalAsm(..)
- | hir::ItemKind::Impl(..)
+ | hir::ItemKind::Impl { .. }
| hir::ItemKind::Use(..) => return,
};
- self.check_missing_docs_attrs(cx, &it.attrs, it.span, desc);
+ let (article, desc) = cx.tcx.article_and_description(it.def_id.to_def_id());
+
+ let attrs = cx.tcx.hir().attrs(it.hir_id());
+ self.check_missing_docs_attrs(cx, attrs, it.span, article, desc);
}
- fn check_trait_item(&mut self, cx: &LateContext<'a, 'tcx>, trait_item: &'tcx hir::TraitItem) {
- let desc = match trait_item.kind {
- hir::TraitItemKind::Const(..) => "an associated constant",
- hir::TraitItemKind::Method(..) => "a trait method",
- hir::TraitItemKind::Type(..) => "an associated type",
- };
+ fn check_trait_item(&mut self, cx: &LateContext<'tcx>, trait_item: &'tcx hir::TraitItem<'_>) {
+ let (article, desc) = cx.tcx.article_and_description(trait_item.def_id.to_def_id());
- self.check_missing_docs_attrs(cx, &trait_item.attrs, trait_item.span, desc);
+ let attrs = cx.tcx.hir().attrs(trait_item.hir_id());
+ self.check_missing_docs_attrs(cx, attrs, trait_item.span, article, desc);
}
- fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, impl_item: &'tcx hir::ImplItem) {
+ fn check_impl_item(&mut self, cx: &LateContext<'tcx>, impl_item: &'tcx hir::ImplItem<'_>) {
// If the method is an impl for a trait, don't doc.
- let def_id = cx.tcx.hir().local_def_id(impl_item.hir_id);
- match cx.tcx.associated_item(def_id).container {
+ match cx.tcx.associated_item(impl_item.def_id).container {
ty::TraitContainer(_) => return,
ty::ImplContainer(cid) => {
if cx.tcx.impl_trait_ref(cid).is_some() {
},
}
- let desc = match impl_item.kind {
- hir::ImplItemKind::Const(..) => "an associated constant",
- hir::ImplItemKind::Method(..) => "a method",
- hir::ImplItemKind::TyAlias(_) => "an associated type",
- hir::ImplItemKind::OpaqueTy(_) => "an existential type",
- };
- self.check_missing_docs_attrs(cx, &impl_item.attrs, impl_item.span, desc);
+ let (article, desc) = cx.tcx.article_and_description(impl_item.def_id.to_def_id());
+ let attrs = cx.tcx.hir().attrs(impl_item.hir_id());
+ self.check_missing_docs_attrs(cx, attrs, impl_item.span, article, desc);
}
- fn check_struct_field(&mut self, cx: &LateContext<'a, 'tcx>, sf: &'tcx hir::StructField) {
+ fn check_field_def(&mut self, cx: &LateContext<'tcx>, sf: &'tcx hir::FieldDef<'_>) {
if !sf.is_positional() {
- self.check_missing_docs_attrs(cx, &sf.attrs, sf.span, "a struct field");
+ let attrs = cx.tcx.hir().attrs(sf.hir_id);
+ self.check_missing_docs_attrs(cx, attrs, sf.span, "a", "struct field");
}
}
- fn check_variant(&mut self, cx: &LateContext<'a, 'tcx>, v: &'tcx hir::Variant) {
- self.check_missing_docs_attrs(cx, &v.attrs, v.span, "a variant");
+ fn check_variant(&mut self, cx: &LateContext<'tcx>, v: &'tcx hir::Variant<'_>) {
+ let attrs = cx.tcx.hir().attrs(v.id);
+ self.check_missing_docs_attrs(cx, attrs, v.span, "a", "variant");
}
}
projects / rust.git / blobdiff