Add documentation on filter_doc_attr

GuillaumeGomez · GuillaumeGomez · commit be881f8fa09a · 2023-11-03T15:44:04.000+01:00
diff --git a/src/librustdoc/clean/mod.rs b/src/librustdoc/clean/mod.rs
@@ -2650,6 +2650,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
`@@ -2650,6 +2650,8 @@ fn filter_doc_attr_ident(ident: Symbol, is_inline: bool) -> bool {`
`2650`	`2650`	`}`
`2651`	`2651`	`}`
`2652`	`2652`
	`2653`	+/// Remove attributes from `normal` that should not be inherited by `use` re-export.
	`2654`	+/// Before calling this function, make sure `normal` is a `#[doc]` attribute.
`2653`	`2655`	`fn filter_doc_attr(normal: &mut ast::NormalAttr, is_inline: bool) {`
`2654`	`2656`	`match normal.item.args {`
`2655`	`2657`	`ast::AttrArgs::Delimited(ref mut args) => {`