Merge pull request rust-lang#3063 from otavio/add-doc-is_doc_comment

nrc · web-flow · commit b32cf4aad8e4 · 2018-10-08T10:41:18.000+13:00
comment: Add documentation to `is_doc_comment` public method
diff --git a/src/comment.rs b/src/comment.rs
@@ -73,6 +73,7 @@ impl<'a> CommentStyle<'a> {
         }
     }
 
+    /// Returns true if the commenting style is for documentation.
     pub fn is_doc_comment(&self) -> bool {
         match *self {
             CommentStyle::TripleSlash | CommentStyle::Doc => true,

Original file line number	Diff line number	Diff line change
`@@ -73,6 +73,7 @@ impl<'a> CommentStyle<'a> {`
`73`	`73`	`}`
`74`	`74`	`}`
`75`	`75`
	`76`	`+ /// Returns true if the commenting style is for documentation.`
`76`	`77`	`pub fn is_doc_comment(&self) -> bool {`
`77`	`78`	`match *self {`
`78`	`79`	`CommentStyle::TripleSlash \| CommentStyle::Doc => true,`