Rollup merge of rust-lang#101536 - GuillaumeGomez:is_doc_comment-doc, r=lqd

matthiaskrgr · web-flow · commit 41e1830a43be · 2022-09-07T21:48:23.000+02:00
Add documentation for Attr::is_doc_comment

The function name is very misleading, some explanations won't hurt.

r? `@lqd`
diff --git a/compiler/rustc_ast/src/attr/mod.rs b/compiler/rustc_ast/src/attr/mod.rs
@@ -232,6 +232,8 @@ impl AttrItem {
 }
 
 impl Attribute {
+    /// Returns `true` if it is a sugared doc comment (`///` or `//!` for example).
+    /// So `#[doc = "doc"]` will return `false`.
     pub fn is_doc_comment(&self) -> bool {
         match self.kind {
             AttrKind::Normal(..) => false,

Original file line number	Diff line number	Diff line change
`@@ -232,6 +232,8 @@ impl AttrItem {`
`232`	`232`	`}`
`233`	`233`
`234`	`234`	`impl Attribute {`
	`235`	+ /// Returns `true` if it is a sugared doc comment (`///` or `//!` for example).
	`236`	+ /// So `#[doc = "doc"]` will return `false`.
`235`	`237`	`pub fn is_doc_comment(&self) -> bool {`
`236`	`238`	`match self.kind {`
`237`	`239`	`AttrKind::Normal(..) => false,`