Add documentation on filter_doc_attr

GuillaumeGomez · GuillaumeGomez · commit 4be2842c8c7d · 2023-06-28T20:32:47.000+02:00
diff --git a/src/librustdoc/clean/mod.rs b/src/librustdoc/clean/mod.rs
@@ -2363,6 +2363,8 @@ fn filter_doc_attr_ident(ident: Symbol, is_inline: bool) -> bool {
     }
 }
 
+/// Remove attributes from `normal` that should not be inherited by `use` re-export.
+/// Before calling this function, make sure `normal` is a `#[doc]` attribute.
 fn filter_doc_attr(normal: &mut ast::NormalAttr, is_inline: bool) {
     match normal.item.args {
         ast::AttrArgs::Delimited(ref mut args) => {

Original file line number	Diff line number	Diff line change
`@@ -2363,6 +2363,8 @@ fn filter_doc_attr_ident(ident: Symbol, is_inline: bool) -> bool {`
`2363`	`2363`	`}`
`2364`	`2364`	`}`
`2365`	`2365`
	`2366`	+/// Remove attributes from `normal` that should not be inherited by `use` re-export.
	`2367`	+/// Before calling this function, make sure `normal` is a `#[doc]` attribute.
`2366`	`2368`	`fn filter_doc_attr(normal: &mut ast::NormalAttr, is_inline: bool) {`
`2367`	`2369`	`match normal.item.args {`
`2368`	`2370`	`ast::AttrArgs::Delimited(ref mut args) => {`