Add some module docs

This commit is contained in:
Jeremy Kolb 2019-12-21 15:27:38 -05:00
parent 2a6322c99e
commit 4ef5cd9a89
9 changed files with 14 additions and 9 deletions

View file

@ -1,4 +1,4 @@
//! FIXME: write short doc here
//! Advertizes the capabilities of the LSP Server.
use lsp_types::{
CodeActionProviderCapability, CodeLensOptions, CompletionOptions,

View file

@ -1,4 +1,4 @@
//! FIXME: write short doc here
//! Convenience module responsible for translating between rust-analyzer's types and LSP types.
use lsp_types::{
self, CreateFile, DiagnosticSeverity, DocumentChangeOperation, DocumentChanges, Documentation,

View file

@ -1,4 +1,5 @@
//! FIXME: write short doc here
//! The main loop of `ra_lsp_server` responsible for dispatching LSP requests/replies and
//! notifications back to the client.
mod handlers;
mod subscriptions;

View file

@ -1,4 +1,5 @@
//! FIXME: write short doc here
//! This module is responsible for implementing handlers for Lanuage Server Protocol.
//! The majority of requests are fulfilled by calling into the `ra_ide` crate.
use std::{fmt::Write as _, io::Write as _};

View file

@ -1,4 +1,4 @@
//! FIXME: write short doc here
//! Datastructures that keep track of inflight requests.
use std::time::{Duration, Instant};

View file

@ -1,4 +1,4 @@
//! FIXME: write short doc here
//! Keeps track of file subscriptions.
use ra_ide::FileId;
use rustc_hash::FxHashSet;

View file

@ -1,4 +1,4 @@
//! FIXME: write short doc here
//! Transforms markdown
pub(crate) fn format_docs(src: &str) -> String {
let mut processed_lines = Vec::new();

View file

@ -1,4 +1,4 @@
//! FIXME: write short doc here
//! Defines `rust-analyzer` specific custom messages.
use lsp_types::{Location, Position, Range, TextDocumentIdentifier, Url};
use rustc_hash::FxHashMap;

View file

@ -1,4 +1,7 @@
//! FIXME: write short doc here
//! The context or environment in which the language server functions.
//! In our server implementation this is know as the `WorldState`.
//!
//! Each tick provides an immutable snapshot of the state as `WorldSnapshot`.
use std::{
path::{Path, PathBuf},