]> git.lizzy.rs Git - rust.git/commitdiff
Fix not displayed re-export of `doc(hidden)` item
authorGuillaume Gomez <guillaume.gomez@huawei.com>
Wed, 11 Jan 2023 19:41:07 +0000 (20:41 +0100)
committerGuillaume Gomez <guillaume.gomez@huawei.com>
Thu, 12 Jan 2023 17:03:03 +0000 (18:03 +0100)
src/librustdoc/passes/strip_priv_imports.rs
src/librustdoc/passes/strip_private.rs
src/librustdoc/passes/stripper.rs

index 3bac5a8e5d7490cd8614790559a83b2f68917616..4c992e94833d6f4f6a5906bdd24838f5cb61f3fc 100644 (file)
@@ -12,5 +12,6 @@
 };
 
 pub(crate) fn strip_priv_imports(krate: clean::Crate, cx: &mut DocContext<'_>) -> clean::Crate {
-    ImportStripper { tcx: cx.tcx }.fold_crate(krate)
+    let is_json_output = cx.output_format.is_json() && !cx.show_coverage;
+    ImportStripper { tcx: cx.tcx, is_json_output }.fold_crate(krate)
 }
index 8fc42462de9696cba2fe15bb85c3ba1c9a6c6113..bb6dccb7c949939bf3e36ef98b2264a1807692fe 100644 (file)
@@ -28,7 +28,8 @@ pub(crate) fn strip_private(mut krate: clean::Crate, cx: &mut DocContext<'_>) ->
             is_json_output,
             tcx: cx.tcx,
         };
-        krate = ImportStripper { tcx: cx.tcx }.fold_crate(stripper.fold_crate(krate));
+        krate =
+            ImportStripper { tcx: cx.tcx, is_json_output }.fold_crate(stripper.fold_crate(krate));
     }
 
     // strip all impls referencing private items
index f8a0d77538d395f230c0c1a36338f9b9c38a8363..f5501b3d5238b82c1ef80326f4a85061e0ddd0da 100644 (file)
@@ -243,12 +243,25 @@ fn fold_item(&mut self, i: Item) -> Option<Item> {
 /// This stripper discards all private import statements (`use`, `extern crate`)
 pub(crate) struct ImportStripper<'tcx> {
     pub(crate) tcx: TyCtxt<'tcx>,
+    pub(crate) is_json_output: bool,
+}
+
+impl<'tcx> ImportStripper<'tcx> {
+    fn import_should_be_hidden(&self, i: &Item, imp: &clean::Import) -> bool {
+        if self.is_json_output {
+            // FIXME: This should be handled the same way as for HTML output.
+            imp.imported_item_is_doc_hidden(self.tcx)
+        } else {
+            i.attrs.lists(sym::doc).has_word(sym::hidden)
+        }
+    }
 }
 
 impl<'tcx> DocFolder for ImportStripper<'tcx> {
     fn fold_item(&mut self, i: Item) -> Option<Item> {
         match *i.kind {
-            clean::ImportItem(imp) if imp.imported_item_is_doc_hidden(self.tcx) => None,
+            clean::ImportItem(imp) if self.import_should_be_hidden(&i, &imp) => None,
+            clean::ImportItem(_) if i.attrs.lists(sym::doc).has_word(sym::hidden) => None,
             clean::ExternCrateItem { .. } | clean::ImportItem(..)
                 if i.visibility(self.tcx) != Some(Visibility::Public) =>
             {