diff options
| author | Aleksey Kladov <[email protected]> | 2021-05-22 14:53:47 +0100 |
|---|---|---|
| committer | Aleksey Kladov <[email protected]> | 2021-05-22 14:53:47 +0100 |
| commit | 188b0f96f98feaa0771f941343887c46113c8ced (patch) | |
| tree | 870d3afb3479ea9f0c323d7c539ce615ec4a4651 /crates/project_model/src/project_json.rs | |
| parent | e6776c3e1b66c8946873d20e1e3bc1d743c952fe (diff) | |
Add more docs
Diffstat (limited to 'crates/project_model/src/project_json.rs')
| -rw-r--r-- | crates/project_model/src/project_json.rs | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/crates/project_model/src/project_json.rs b/crates/project_model/src/project_json.rs index 41a2ac03e..e8f1aca61 100644 --- a/crates/project_model/src/project_json.rs +++ b/crates/project_model/src/project_json.rs | |||
| @@ -1,4 +1,9 @@ | |||
| 1 | //! FIXME: write short doc here | 1 | //! `rust-project.json` file format. |
| 2 | //! | ||
| 3 | //! This format is spiritually a serialization of [`base_db::CrateGraph`]. The | ||
| 4 | //! idea here is that people who do not use Cargo, can instead teach their build | ||
| 5 | //! system to generate `rust-project.json` which can be ingested by | ||
| 6 | //! rust-analyzer. | ||
| 2 | 7 | ||
| 3 | use std::path::PathBuf; | 8 | use std::path::PathBuf; |
| 4 | 9 | ||