rust/crates/ra_hir/src/docs.rs
2019-01-26 10:35:23 -05:00

31 lines
626 B
Rust

use ra_syntax::ast;
use crate::HirDatabase;
/// Holds documentation
#[derive(Debug, Clone)]
pub struct Documentation(String);
impl Documentation {
pub fn new(s: &str) -> Self {
Self(s.into())
}
pub fn contents(&self) -> &str {
&self.0
}
}
impl Into<String> for Documentation {
fn into(self) -> String {
self.contents().into()
}
}
pub trait Docs {
fn docs(&self, db: &impl HirDatabase) -> Option<Documentation>;
}
pub(crate) fn docs_from_ast(node: &impl ast::DocCommentsOwner) -> Option<Documentation> {
node.doc_comment_text().map(|it| Documentation::new(&it))
}