Add documentation on filter_doc_attr

GuillaumeGomez · GuillaumeGomez · commit 823148fa849e · 2023-11-22T17:22:30.000+01:00
diff --git a/src/librustdoc/clean/mod.rs b/src/librustdoc/clean/mod.rs
@@ -2656,6 +2656,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
`@@ -2656,6 +2656,8 @@ fn filter_doc_attr_ident(ident: Symbol, is_inline: bool) -> bool {`
`2656`	`2656`	`}`
`2657`	`2657`	`}`
`2658`	`2658`
	`2659`	+/// Remove attributes from `normal` that should not be inherited by `use` re-export.
	`2660`	+/// Before calling this function, make sure `normal` is a `#[doc]` attribute.
`2659`	`2661`	`fn filter_doc_attr(normal: &mut ast::NormalAttr, is_inline: bool) {`
`2660`	`2662`	`match normal.item.args {`
`2661`	`2663`	`ast::AttrArgs::Delimited(ref mut args) => {`