From 32f056ce6b91d6f63dd93f7e82202fa6308e02ee Mon Sep 17 00:00:00 2001 From: Guillaume Gomez Date: Mon, 26 Jun 2023 16:32:59 +0200 Subject: [PATCH] Add/improve code comments --- src/librustdoc/clean/mod.rs | 2 +- src/librustdoc/clean/types.rs | 3 +++ tests/rustdoc/reexport-doc-hidden-inside-private.rs | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/src/librustdoc/clean/mod.rs b/src/librustdoc/clean/mod.rs index f86c32158e0..625e0d7bd8d 100644 --- a/src/librustdoc/clean/mod.rs +++ b/src/librustdoc/clean/mod.rs @@ -2377,7 +2377,7 @@ fn filter_tokens_from_list( tokens } -/// When inlining items, we merge its attributes (and all the reexports attributes too) with the +/// When inlining items, we merge their attributes (and all the reexports attributes too) with the /// final reexport. For example: /// /// ```ignore (just an example) diff --git a/src/librustdoc/clean/types.rs b/src/librustdoc/clean/types.rs index 5f5cade67a2..26139d52769 100644 --- a/src/librustdoc/clean/types.rs +++ b/src/librustdoc/clean/types.rs @@ -956,6 +956,8 @@ fn single(it: T) -> Option { .filter_map(|attr| Cfg::parse(attr.meta_item()?).ok()) .fold(Cfg::True, |cfg, new_cfg| cfg & new_cfg) } else if doc_auto_cfg_active { + // If there is no `doc(cfg())`, then we retrieve the `cfg()` attributes (because + // `doc(cfg())` overrides `cfg()`). self.iter() .filter(|attr| attr.has_name(sym::cfg)) .filter_map(|attr| single(attr.meta_item_list()?)) @@ -2387,6 +2389,7 @@ pub(crate) fn as_blanket_ty(&self) -> Option<&Type> { #[derive(Clone, Debug)] pub(crate) struct Import { pub(crate) kind: ImportKind, + /// The item being re-exported. pub(crate) source: ImportSource, pub(crate) should_be_displayed: bool, } diff --git a/tests/rustdoc/reexport-doc-hidden-inside-private.rs b/tests/rustdoc/reexport-doc-hidden-inside-private.rs index 1e4216d3c0c..e9d243d8abf 100644 --- a/tests/rustdoc/reexport-doc-hidden-inside-private.rs +++ b/tests/rustdoc/reexport-doc-hidden-inside-private.rs @@ -1,4 +1,4 @@ -// This test ensures that a re-export of `#[doc(hidden)]` item inside a private +// This test ensures that a re-export of `#[doc(hidden)]` item inside a private // module will still be displayed (the re-export, not the item). #![crate_name = "foo"]