language-servers/rust-analyzer
1
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer.git synced 2025-09-28 21:05:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

Move docs to Function

Browse source
This commit is contained in:
Jeremy Kolb 2019-01-22 08:55:05 -05:00
parent b77d780f0e
commit b540451483
3 changed files with 18 additions and 13 deletions
Download patch file Download diff file Expand all files Collapse all files

21
crates/ra_hir/src/code_model_api.rs
View file

@ -2,7 +2,7 @@ use std::sync::Arc;
use relative_path::RelativePathBuf;
use ra_db::{CrateId, FileId};
use ra_syntax::{ast, TreeArc, SyntaxNode};
use ra_syntax::{ast::{self, AstNode, DocCommentsOwner}, TreeArc, SyntaxNode};
use crate::{
Name, DefId, Path, PerNs, ScopesWithSyntaxMapping, Ty, HirFileId,
@ -297,7 +297,6 @@ pub struct FnSignature {
/// True if the first param is `self`. This is relevant to decide whether this
/// can be called as a method.
pub(crate) has_self_param: bool,
pub(crate) documentation: String,
}
impl FnSignature {
@ -318,10 +317,6 @@ impl FnSignature {
pub fn has_self_param(&self) -> bool {
self.has_self_param
}
pub fn documentation(&self) -> &String {
&self.documentation
}
}
impl Function {
@ -357,6 +352,20 @@ impl Function {
pub fn generic_params(&self, db: &impl HirDatabase) -> Arc<GenericParams> {
db.generic_params(self.def_id)
}
pub fn docs(&self, db: &impl HirDatabase) -> Option<String> {
let def_loc = self.def_id.loc(db);
let syntax = db.file_item(def_loc.source_item_id);
let fn_def = ast::FnDef::cast(&syntax).expect("fn def should point to FnDef node");
// doc_comment_text unconditionally returns a String
let comments = fn_def.doc_comment_text();
if comments.is_empty() {
None
} else {
Some(comments)
}
}
}
#[derive(Debug, Clone, PartialEq, Eq, Hash)]