mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge #1879

Browse Source 
1879: A few doc comments r=matklad a=kjeremy



Co-authored-by: kjeremy <kjeremy@gmail.com>
This commit is contained in:
bors[bot] 2019-09-20 08:02:51 +00:00 committed by GitHub
commit 4101c15ddb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
crates/ra_ide_api/src/lib.rs
View File

@ -223,6 +223,7 @@ impl Query {
}
}
/// Info associated with a text range.
#[derive(Debug)]
pub struct RangeInfo<T> {
pub range: TextRange,
@ -235,6 +236,8 @@ impl<T> RangeInfo<T> {
}
}
/// Contains information about a call site. Specifically the
/// `FunctionSignature`and current parameter.
#[derive(Debug)]
pub struct CallInfo {
pub signature: FunctionSignature,
@ -325,11 +328,12 @@ impl Analysis {
(host.analysis(), file_id)
}
/// Features for Analysis.
pub fn feature_flags(&self) -> &FeatureFlags {
&self.db.feature_flags
}
/// Debug info about the current state of the analysis
/// Debug info about the current state of the analysis.
pub fn status(&self) -> Cancelable<String> {
self.with_db(|db| status::status(&*db))
}
@ -440,6 +444,7 @@ impl Analysis {
})
}
/// Returns the definitions from the symbol at `position`.
pub fn goto_definition(
&self,
position: FilePosition,
@ -447,6 +452,7 @@ impl Analysis {
self.with_db(|db| goto_definition::goto_definition(db, position))
}
/// Returns the impls from the symbol at `position`.
pub fn goto_implementation(
&self,
position: FilePosition,
@ -454,6 +460,7 @@ impl Analysis {
self.with_db(|db| impls::goto_implementation(db, position))
}
/// Returns the type definitions for the symbol at `position`.
pub fn goto_type_definition(
&self,
position: FilePosition,
@ -540,6 +547,7 @@ impl Analysis {
self.with_db(|db| references::rename(db, position, new_name))
}
/// Performs an operation on that may be Canceled.
fn with_db<F: FnOnce(&db::RootDatabase) -> T + std::panic::UnwindSafe, T>(
&self,
f: F,