aboutsummaryrefslogtreecommitdiff
path: root/crates
diff options
context:
space:
mode:
authorAleksey Kladov <[email protected]>2019-01-08 19:45:52 +0000
committerAleksey Kladov <[email protected]>2019-01-08 19:45:52 +0000
commit0c62b1bb7a49bf527780ce1f8cade5eb4fbfdb2d (patch)
tree2bc001c8ecf58b49ac9a0da1f20d5644ce29fb3a /crates
parent5b573deb20b15451788dd2861e9fc6e69ed0472e (diff)
fix the docs
Diffstat (limited to 'crates')
-rw-r--r--crates/ra_db/src/lib.rs2
-rw-r--r--crates/ra_ide_api/src/lib.rs10
2 files changed, 9 insertions, 3 deletions
diff --git a/crates/ra_db/src/lib.rs b/crates/ra_db/src/lib.rs
index f56f70983..e680d9fc3 100644
--- a/crates/ra_db/src/lib.rs
+++ b/crates/ra_db/src/lib.rs
@@ -1,4 +1,4 @@
1//! ra_db defines basic database traits. Concrete DB is defined by ra_analysis. 1//! ra_db defines basic database traits. Concrete DB is defined by ra_ide_api.
2mod cancelation; 2mod cancelation;
3mod syntax_ptr; 3mod syntax_ptr;
4mod input; 4mod input;
diff --git a/crates/ra_ide_api/src/lib.rs b/crates/ra_ide_api/src/lib.rs
index 183e36706..7e9ca2034 100644
--- a/crates/ra_ide_api/src/lib.rs
+++ b/crates/ra_ide_api/src/lib.rs
@@ -1,8 +1,14 @@
1//! ra_analyzer crate provides "ide-centric" APIs for the rust-analyzer. What 1//! ra_ide_api crate provides "ide-centric" APIs for the rust-analyzer. That is,
2//! powers this API are the `RootDatabase` struct, which defines a `salsa` 2//! it generally operates with files and text ranges, and returns results as
3//! Strings, suitable for displaying to the human.
4//!
5//! What powers this API are the `RootDatabase` struct, which defines a `salsa`
3//! database, and the `ra_hir` crate, where majority of the analysis happens. 6//! database, and the `ra_hir` crate, where majority of the analysis happens.
4//! However, IDE specific bits of the analysis (most notably completion) happen 7//! However, IDE specific bits of the analysis (most notably completion) happen
5//! in this crate. 8//! in this crate.
9//!
10//! The sibling `ra_ide_api_light` handles thouse bits of IDE functionality
11//! which are restricted to a single file and need only syntax.
6macro_rules! ctry { 12macro_rules! ctry {
7 ($expr:expr) => { 13 ($expr:expr) => {
8 match $expr { 14 match $expr {