aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKirill Bulatov <[email protected]>2020-08-11 13:08:55 +0100
committerKirill Bulatov <[email protected]>2020-08-11 13:09:08 +0100
commit37aa68f050fae0079db7b6ebd81bacea4441fb7e (patch)
treeff7ea3a8fdd8d15bf3603048a20e0b9e222c6451
parentc8cad76d25f7fab856c9646b70122e0f9f7d7218 (diff)
Add rustdocs
-rw-r--r--crates/ra_hir_expand/src/diagnostics.rs1
-rw-r--r--crates/ra_ide/src/diagnostics/diagnostics_with_fix.rs4
2 files changed, 4 insertions, 1 deletions
diff --git a/crates/ra_hir_expand/src/diagnostics.rs b/crates/ra_hir_expand/src/diagnostics.rs
index e58defa68..cc7dc3af2 100644
--- a/crates/ra_hir_expand/src/diagnostics.rs
+++ b/crates/ra_hir_expand/src/diagnostics.rs
@@ -22,6 +22,7 @@ use crate::InFile;
22 22
23pub trait Diagnostic: Any + Send + Sync + fmt::Debug + 'static { 23pub trait Diagnostic: Any + Send + Sync + fmt::Debug + 'static {
24 fn message(&self) -> String; 24 fn message(&self) -> String;
25 /// A presentation source of the diagnostics, to use in highlighting and similar actions
25 fn presentation(&self) -> InFile<SyntaxNodePtr>; 26 fn presentation(&self) -> InFile<SyntaxNodePtr>;
26 fn as_any(&self) -> &(dyn Any + Send + 'static); 27 fn as_any(&self) -> &(dyn Any + Send + 'static);
27 fn is_experimental(&self) -> bool { 28 fn is_experimental(&self) -> bool {
diff --git a/crates/ra_ide/src/diagnostics/diagnostics_with_fix.rs b/crates/ra_ide/src/diagnostics/diagnostics_with_fix.rs
index 56d454ac6..1955e1521 100644
--- a/crates/ra_ide/src/diagnostics/diagnostics_with_fix.rs
+++ b/crates/ra_ide/src/diagnostics/diagnostics_with_fix.rs
@@ -1,3 +1,4 @@
1//! Provides a way to derive fixes based on the diagnostic data.
1use crate::Fix; 2use crate::Fix;
2use ast::{edit::IndentLevel, make}; 3use ast::{edit::IndentLevel, make};
3use hir::{ 4use hir::{
@@ -13,8 +14,9 @@ use ra_ide_db::{
13use ra_syntax::{algo, ast, AstNode, TextRange}; 14use ra_syntax::{algo, ast, AstNode, TextRange};
14use ra_text_edit::{TextEdit, TextEditBuilder}; 15use ra_text_edit::{TextEdit, TextEditBuilder};
15 16
16// TODO kb 17/// A trait to implement fot the Diagnostic that has a fix available.
17pub trait DiagnosticWithFix { 18pub trait DiagnosticWithFix {
19 /// Provides a fix with the fix range, if applicable in the current semantics.
18 fn fix(&self, sema: &Semantics<RootDatabase>) -> Option<(Fix, TextRange)>; 20 fn fix(&self, sema: &Semantics<RootDatabase>) -> Option<(Fix, TextRange)>;
19} 21}
20 22