use rustc::hir;
use rustc::lint::*;
+use rustc::{declare_lint, lint_array};
use rustc::ty;
use syntax::ast;
use syntax::attr;
use syntax::codemap::Span;
-use utils::in_macro;
+use crate::utils::in_macro;
/// **What it does:** Warns if there is missing doc for any documentable item
/// (public or private).
/// This lint fixes that.
///
/// **Known problems:** None.
-declare_lint! {
+declare_clippy_lint! {
pub MISSING_DOCS_IN_PRIVATE_ITEMS,
- Allow,
+ restriction,
"detects missing documentation for public and private members"
}
let has_doc = attrs
.iter()
- .any(|a| a.is_value_str() && a.name().map_or(false, |n| n == "doc"));
+ .any(|a| a.is_value_str() && a.name() == "doc");
if !has_doc {
cx.span_lint(
MISSING_DOCS_IN_PRIVATE_ITEMS,
fn check_item(&mut self, cx: &LateContext<'a, 'tcx>, it: &'tcx hir::Item) {
let desc = match it.node {
- hir::ItemConst(..) => "a constant",
- hir::ItemEnum(..) => "an enum",
- hir::ItemFn(..) => "a function",
- hir::ItemMod(..) => "a module",
- hir::ItemStatic(..) => "a static",
- hir::ItemStruct(..) => "a struct",
- hir::ItemTrait(..) => "a trait",
- hir::ItemGlobalAsm(..) => "an assembly blob",
- hir::ItemTy(..) => "a type alias",
- hir::ItemUnion(..) => "a union",
- hir::ItemDefaultImpl(..) |
- hir::ItemExternCrate(..) |
- hir::ItemForeignMod(..) |
- hir::ItemImpl(..) |
- hir::ItemUse(..) => return,
+ hir::ItemKind::Const(..) => "a constant",
+ hir::ItemKind::Enum(..) => "an enum",
+ hir::ItemKind::Fn(..) => {
+ // ignore main()
+ if it.name == "main" {
+ let def_id = cx.tcx.hir.local_def_id(it.id);
+ let def_key = cx.tcx.hir.def_key(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::GlobalAsm(..) => "an assembly blob",
+ hir::ItemKind::Ty(..) => "a type alias",
+ hir::ItemKind::Union(..) => "a union",
+ hir::ItemKind::Existential(..) => "an existential type",
+ hir::ItemKind::ExternCrate(..) |
+ hir::ItemKind::ForeignMod(..) |
+ hir::ItemKind::Impl(..) |
+ hir::ItemKind::Use(..) => return,
};
self.check_missing_docs_attrs(cx, &it.attrs, it.span, desc);
hir::ImplItemKind::Const(..) => "an associated constant",
hir::ImplItemKind::Method(..) => "a method",
hir::ImplItemKind::Type(_) => "an associated type",
+ hir::ImplItemKind::Existential(_) => "an existential type",
};
self.check_missing_docs_attrs(cx, &impl_item.attrs, impl_item.span, desc);
}