From 962a491829c2a803f5dc8c8c5e173baa89079e8b Mon Sep 17 00:00:00 2001
From: Aleksey Kladov <aleksey.kladov@gmail.com>
Date: Thu, 1 Nov 2018 14:31:25 +0300
Subject: Some docs

---
 crates/ra_analysis/src/lib.rs | 12 ++++++++++++
 1 file changed, 12 insertions(+)

(limited to 'crates/ra_analysis')

diff --git a/crates/ra_analysis/src/lib.rs b/crates/ra_analysis/src/lib.rs
index 32aa7a1fd..d21be3a88 100644
--- a/crates/ra_analysis/src/lib.rs
+++ b/crates/ra_analysis/src/lib.rs
@@ -1,3 +1,6 @@
+//! ra_analyzer crate is the brain of Rust analyzer. It relies on the `salsa`
+//! crate, which provides and incremental on-deman database of facts.
+
 extern crate fst;
 extern crate ra_editor;
 extern crate ra_syntax;
@@ -95,6 +98,7 @@ impl AnalysisChange {
     }
 }
 
+/// `AnalysisHost` stores the current state of the world.
 #[derive(Debug)]
 pub struct AnalysisHost {
     imp: AnalysisHostImpl,
@@ -106,11 +110,15 @@ impl AnalysisHost {
             imp: AnalysisHostImpl::new(),
         }
     }
+    /// Returns a snapshot of the current state, which you can query for
+    /// semantic information.
     pub fn analysis(&self) -> Analysis {
         Analysis {
             imp: self.imp.analysis(),
         }
     }
+    /// Applies changes to the current state of the world. If there are
+    /// outstanding snapshots, they will be canceled.
     pub fn apply_change(&mut self, change: AnalysisChange) {
         self.imp.apply_change(change)
     }
@@ -191,6 +199,10 @@ impl Query {
     }
 }
 
+/// Analysis is a snapshot of a world state at a moment in time. It is the main
+/// entry point for asking semantic information about the world. When the world
+/// state is advanced using `AnalysisHost::apply_change` method, all existing
+/// `Analysis` are canceled (most method return `Err(Canceled)`).
 #[derive(Debug)]
 pub struct Analysis {
     pub(crate) imp: AnalysisImpl,
-- 
cgit v1.2.3