src/librustdoc/passes/private_items_doc_tests.rs

   1 use crate::clean::*;
   2 use crate::core::DocContext;
   3 use crate::fold::DocFolder;
   4 use crate::passes::{look_for_tests, Pass};
   5
   6 pub const CHECK_PRIVATE_ITEMS_DOC_TESTS: Pass = Pass {
   7     name: "check-private-items-doc-tests",
   8     pass: check_private_items_doc_tests,
   9     description: "check private items doc tests",
  10 };
  11
  12 struct PrivateItemDocTestLinter<'a, 'tcx> {
  13     cx: &'a DocContext<'tcx>,
  14 }
  15
  16 impl<'a, 'tcx> PrivateItemDocTestLinter<'a, 'tcx> {
  17     fn new(cx: &'a DocContext<'tcx>) -> Self {
  18         PrivateItemDocTestLinter {
  19             cx,
  20         }
  21     }
  22 }
  23
  24 pub fn check_private_items_doc_tests(krate: Crate, cx: &DocContext<'_>) -> Crate {
  25     let mut coll = PrivateItemDocTestLinter::new(cx);
  26
  27     coll.fold_crate(krate)
  28 }
  29
  30 impl<'a, 'tcx> DocFolder for PrivateItemDocTestLinter<'a, 'tcx> {
  31     fn fold_item(&mut self, item: Item) -> Option<Item> {
  32         let cx = self.cx;
  33         let dox = item.attrs.collapsed_doc_value().unwrap_or_else(String::new);
  34
  35         look_for_tests(&cx, &dox, &item, false);
  36
  37         self.fold_item_recur(item)
  38     }
  39 }