diff options
Diffstat (limited to 'crates/ra_ide_api/src')
| -rw-r--r-- | crates/ra_ide_api/src/lib.rs | 10 |
1 files changed, 8 insertions, 2 deletions
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. | ||
| 6 | macro_rules! ctry { | 12 | macro_rules! ctry { |
| 7 | ($expr:expr) => { | 13 | ($expr:expr) => { |
| 8 | match $expr { | 14 | match $expr { |