Merge #646

646: Add module documentation support r=matklad a=kjeremy



Co-authored-by: Jeremy A. Kolb <[email protected]>

4 files changed, 50 insertions, 1 deletions

diff --git a/crates/ra_hir/src/code_model_api.rs b/crates/ra_hir/src/code_model_api.rs
index fdea5be57..1e88bff8b 100644
--- a/crates/ra_hir/src/code_model_api.rs
+++ b/crates/ra_hir/src/code_model_api.rs
@@ -177,6 +177,13 @@ impl Module {
     }
 }
 
+impl Docs for Module {
+    fn docs(&self, db: &impl HirDatabase) -> Option<Documentation> {
+        self.declaration_source(db)
+            .and_then(|it| docs_from_ast(&*it.1))
+    }
+}
+
 #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
 pub struct StructField {
     pub(crate) parent: VariantDef,
diff --git a/crates/ra_ide_api/src/completion/complete_path.rs b/crates/ra_ide_api/src/completion/complete_path.rs
index 172aedf95..b33ddcde5 100644
--- a/crates/ra_ide_api/src/completion/complete_path.rs
+++ b/crates/ra_ide_api/src/completion/complete_path.rs
@@ -66,6 +66,22 @@ mod tests {
     }
 
     #[test]
+    fn completes_mod_with_docs() {
+        check_reference_completion(
+            "mod_with_docs",
+            r"
+            use self::my<|>;
+
+            /// Some simple
+            /// docs describing `mod my`.
+            mod my {
+                struct Bar;
+            }
+            ",
+        );
+    }
+
+    #[test]
     fn completes_use_item_starting_with_self() {
         check_reference_completion(
             "use_item_starting_with_self",
diff --git a/crates/ra_ide_api/src/completion/completion_item.rs b/crates/ra_ide_api/src/completion/completion_item.rs
index b2b047766..b16ac2b28 100644
--- a/crates/ra_ide_api/src/completion/completion_item.rs
+++ b/crates/ra_ide_api/src/completion/completion_item.rs
@@ -215,7 +215,7 @@ impl Builder {
             Some(it) => it,
         };
         let (kind, docs) = match def {
-            hir::ModuleDef::Module(_) => (CompletionItemKind::Module, None),
+            hir::ModuleDef::Module(it) => (CompletionItemKind::Module, it.docs(ctx.db)),
             hir::ModuleDef::Function(func) => return self.from_function(ctx, func),
             hir::ModuleDef::Struct(it) => (CompletionItemKind::Struct, it.docs(ctx.db)),
             hir::ModuleDef::Enum(it) => (CompletionItemKind::Enum, it.docs(ctx.db)),
diff --git a/crates/ra_ide_api/src/completion/snapshots/completion_item__mod_with_docs.snap b/crates/ra_ide_api/src/completion/snapshots/completion_item__mod_with_docs.snap
new file mode 100644
index 000000000..3db7119a7
--- /dev/null
+++ b/crates/ra_ide_api/src/completion/snapshots/completion_item__mod_with_docs.snap
@@ -0,0 +1,26 @@
+---
+created: "2019-01-25T17:49:28.949186500+00:00"
+creator: [email protected]
+expression: kind_completions
+source: crates/ra_ide_api/src/completion/completion_item.rs
+---
+[
+    CompletionItem {
+        completion_kind: Reference,
+        label: "my",
+        kind: Some(
+            Module
+        ),
+        detail: None,
+        documentation: Some(
+            Documentation(
+                "Some simple\ndocs describing `mod my`."
+            )
+        ),
+        lookup: None,
+        insert_text: None,
+        insert_text_format: PlainText,
+        source_range: [23; 25),
+        text_edit: None
+    }
+]