From 052e20162a026356c716116ac10ea795ca5dc28d Mon Sep 17 00:00:00 2001
From: Aleksey Kladov <aleksey.kladov@gmail.com>
Date: Fri, 21 Dec 2018 15:34:11 +0300
Subject: docs

---
 crates/ra_analysis/src/completion/completion_item.rs | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'crates/ra_analysis/src')

diff --git a/crates/ra_analysis/src/completion/completion_item.rs b/crates/ra_analysis/src/completion/completion_item.rs
index 322a7c6be..445d6bf41 100644
--- a/crates/ra_analysis/src/completion/completion_item.rs
+++ b/crates/ra_analysis/src/completion/completion_item.rs
@@ -1,3 +1,6 @@
+/// `CompletionItem` describes a single completion variant in the editor pop-up.
+/// It is basically a POD with various properties. To construct a
+/// `CompletionItem`, use `new` method and the `Builder` struct.
 #[derive(Debug)]
 pub struct CompletionItem {
     label: String,
@@ -41,6 +44,7 @@ impl CompletionItem {
     }
 }
 
+/// A helper to make `CompletionItem`s.
 #[must_use]
 pub(crate) struct Builder {
     label: String,
@@ -76,6 +80,7 @@ impl Into<CompletionItem> for Builder {
     }
 }
 
+/// Represents an in-progress set of completions being built.
 #[derive(Debug)]
 pub(crate) struct Completions {
     buf: Vec<CompletionItem>,
-- 
cgit v1.2.3