Merge #424

424: remove non-doc comments from doc comments r=matklad a=csmoe

Closes #357

Co-authored-by: csmoe <[email protected]>

1 files changed, 25 insertions, 0 deletions

diff --git a/crates/ra_syntax/src/ast.rs b/crates/ra_syntax/src/ast.rs
index e968c9728..3aaa5edda 100644
--- a/crates/ra_syntax/src/ast.rs
+++ b/crates/ra_syntax/src/ast.rs
@@ -115,6 +115,7 @@ pub trait DocCommentsOwner<'a>: AstNode<'a> {
     /// That is, strips leading `///` and joins lines
     fn doc_comment_text(self) -> RustString {
         self.doc_comments()
+            .filter(|comment| comment.is_doc_comment())
             .map(|comment| {
                 let prefix = comment.prefix();
                 let trimmed = comment
@@ -206,6 +207,10 @@ impl<'a> Comment<'a> {
         }
     }
 
+    pub fn is_doc_comment(&self) -> bool {
+        self.flavor().is_doc_comment()
+    }
+
     pub fn prefix(&self) -> &'static str {
         self.flavor().prefix()
     }
@@ -237,6 +242,13 @@ impl CommentFlavor {
             Multiline => "/*",
         }
     }
+
+    pub fn is_doc_comment(&self) -> bool {
+        match self {
+            CommentFlavor::Doc | CommentFlavor::ModuleDoc => true,
+            _ => false,
+        }
+    }
 }
 
 impl<'a> Whitespace<'a> {
@@ -469,3 +481,16 @@ impl<'a> PrefixExpr<'a> {
         }
     }
 }
+
+#[test]
+fn test_doc_comment_of_items() {
+    let file = SourceFileNode::parse(
+        r#"
+        //! doc
+        // non-doc
+        mod foo {}
+        "#,
+    );
+    let module = file.syntax().descendants().find_map(Module::cast).unwrap();
+    assert_eq!("doc", module.doc_comment_text());
+}