clippy_lints/src/missing_doc.rs

   1 /* This file incorporates work covered by the following copyright and
   2  * permission notice:
   3  *   Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
   4  *   file at the top-level directory of this distribution and at
   5  *   http://rust-lang.org/COPYRIGHT.
   6  *
   7  *   Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   8  *   http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   9  *   <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
  10  *   option. This file may not be copied, modified, or distributed
  11  *   except according to those terms.
  12  */
  13
  14 /* Note: More specifically this lint is largely inspired (aka copied) from *rustc*'s
  15  * [`missing_doc`].
  16  *
  17  * [`missing_doc`]: https://github.com/rust-lang/rust/blob/d6d05904697d89099b55da3331155392f1db9c00/src/librustc_lint/builtin.rs#L246
  18  */
  19
  20 use rustc::hir;
  21 use rustc::lint::*;
  22 use rustc::ty;
  23 use syntax::ast;
  24 use syntax::attr;
  25 use syntax::codemap::Span;
  26 use utils::in_macro;
  27
  28 /// **What it does:** Warns if there is missing doc for any documentable item (public or private).
  29 ///
  30 /// **Why is this bad?** Doc is good. *rustc* has a `MISSING_DOCS` allowed-by-default lint for
  31 /// public members, but has no way to enforce documentation of private items. This lint fixes that.
  32 ///
  33 /// **Known problems:** None.
  34 declare_lint! {
  35     pub MISSING_DOCS_IN_PRIVATE_ITEMS,
  36     Allow,
  37     "detects missing documentation for public and private members"
  38 }
  39
  40 pub struct MissingDoc {
  41     /// Stack of whether #[doc(hidden)] is set
  42     /// at each level which has lint attributes.
  43     doc_hidden_stack: Vec<bool>,
  44 }
  45
  46 impl ::std::default::Default for MissingDoc {
  47     fn default() -> MissingDoc {
  48         MissingDoc::new()
  49     }
  50 }
  51
  52 impl MissingDoc {
  53     pub fn new() -> MissingDoc {
  54         MissingDoc {
  55             doc_hidden_stack: vec![false],
  56         }
  57     }
  58
  59     fn doc_hidden(&self) -> bool {
  60         *self.doc_hidden_stack.last().expect("empty doc_hidden_stack")
  61     }
  62
  63     fn check_missing_docs_attrs(&self,
  64                                cx: &LateContext,
  65                                attrs: &[ast::Attribute],
  66                                sp: Span,
  67                                desc: &'static str) {
  68         // If we're building a test harness, then warning about
  69         // documentation is probably not really relevant right now.
  70         if cx.sess().opts.test {
  71             return;
  72         }
  73
  74         // `#[doc(hidden)]` disables missing_docs check.
  75         if self.doc_hidden() {
  76             return;
  77         }
  78
  79         if in_macro(cx, sp) {
  80             return;
  81         }
  82
  83         let has_doc = attrs.iter().any(|a| a.is_value_str() && a.name() == "doc");
  84         if !has_doc {
  85             cx.span_lint(MISSING_DOCS_IN_PRIVATE_ITEMS, sp,
  86                          &format!("missing documentation for {}", desc));
  87         }
  88     }
  89 }
  90
  91 impl LintPass for MissingDoc {
  92     fn get_lints(&self) -> LintArray {
  93         lint_array![MISSING_DOCS_IN_PRIVATE_ITEMS]
  94     }
  95 }
  96
  97 impl LateLintPass for MissingDoc {
  98     fn enter_lint_attrs(&mut self, _: &LateContext, attrs: &[ast::Attribute]) {
  99         let doc_hidden = self.doc_hidden() || attrs.iter().any(|attr| {
 100             attr.check_name("doc") && match attr.meta_item_list() {
 101                 None => false,
 102                 Some(l) => attr::list_contains_name(&l[..], "hidden"),
 103             }
 104         });
 105         self.doc_hidden_stack.push(doc_hidden);
 106     }
 107
 108     fn exit_lint_attrs(&mut self, _: &LateContext, _: &[ast::Attribute]) {
 109         self.doc_hidden_stack.pop().expect("empty doc_hidden_stack");
 110     }
 111
 112     fn check_crate(&mut self, cx: &LateContext, krate: &hir::Crate) {
 113         self.check_missing_docs_attrs(cx, &krate.attrs, krate.span, "crate");
 114     }
 115
 116     fn check_item(&mut self, cx: &LateContext, it: &hir::Item) {
 117         let desc = match it.node {
 118             hir::ItemConst(..) => "a constant",
 119             hir::ItemEnum(..) => "an enum",
 120             hir::ItemFn(..) => "a function",
 121             hir::ItemMod(..) => "a module",
 122             hir::ItemStatic(..) => "a static",
 123             hir::ItemStruct(..) => "a struct",
 124             hir::ItemTrait(..) => "a trait",
 125             hir::ItemTy(..) => "a type alias",
 126             //FIXME:unions: hir::ItemUnion(..) => "a union",
 127             hir::ItemDefaultImpl(..) |
 128             hir::ItemExternCrate(..) |
 129             hir::ItemForeignMod(..) |
 130             hir::ItemImpl(..) |
 131             hir::ItemUse(..) => return,
 132         };
 133
 134         self.check_missing_docs_attrs(cx, &it.attrs, it.span, desc);
 135     }
 136
 137     fn check_trait_item(&mut self, cx: &LateContext, trait_item: &hir::TraitItem) {
 138         let desc = match trait_item.node {
 139             hir::ConstTraitItem(..) => "an associated constant",
 140             hir::MethodTraitItem(..) => "a trait method",
 141             hir::TypeTraitItem(..) => "an associated type",
 142         };
 143
 144         self.check_missing_docs_attrs(cx, &trait_item.attrs, trait_item.span, desc);
 145     }
 146
 147     fn check_impl_item(&mut self, cx: &LateContext, impl_item: &hir::ImplItem) {
 148         // If the method is an impl for a trait, don't doc.
 149         let def_id = cx.tcx.map.local_def_id(impl_item.id);
 150         match cx.tcx.impl_or_trait_items.borrow()
 151                                          .get(&def_id)
 152                                          .expect("missing method descriptor?!")
 153                                          .container() {
 154             ty::TraitContainer(_) => return,
 155             ty::ImplContainer(cid) => {
 156                 if cx.tcx.impl_trait_ref(cid).is_some() {
 157                     return
 158                 }
 159             }
 160         }
 161
 162         let desc = match impl_item.node {
 163             hir::ImplItemKind::Const(..) => "an associated constant",
 164             hir::ImplItemKind::Method(..) => "a method",
 165             hir::ImplItemKind::Type(_) => "an associated type",
 166         };
 167         self.check_missing_docs_attrs(cx, &impl_item.attrs, impl_item.span, desc);
 168     }
 169
 170     fn check_struct_field(&mut self, cx: &LateContext, sf: &hir::StructField) {
 171         if !sf.is_positional() {
 172             self.check_missing_docs_attrs(cx, &sf.attrs, sf.span, "a struct field");
 173         }
 174     }
 175
 176     fn check_variant(&mut self, cx: &LateContext, v: &hir::Variant, _: &hir::Generics) {
 177         self.check_missing_docs_attrs(cx, &v.node.attrs, v.span, "a variant");
 178     }
 179 }