Trait DocGroup 

pub trait DocGroup:
    Database
    + HasQueryGroup<DocDatabase>
    + SemanticGroup
    + Upcast<dyn SemanticGroup> {
    // Required methods
    fn get_item_documentation(
        &self,
        item_id: DocumentableItemId,
    ) -> Option<String>;
    fn get_item_documentation_as_tokens(
        &self,
        item_id: DocumentableItemId,
    ) -> Option<Vec<DocumentationCommentToken>>;
    fn get_item_signature(&self, item_id: DocumentableItemId) -> Option<String>;
    fn get_item_signature_with_links(
        &self,
        item_id: DocumentableItemId,
    ) -> (Option<String>, Vec<LocationLink>);
}

Required Methods

fn get_item_documentation(&self, item_id: DocumentableItemId) -> Option<String>

Gets the documentation of an item.

fn get_item_documentation_as_tokens( &self, item_id: DocumentableItemId, ) -> Option<Vec<DocumentationCommentToken>>

Gets the documentation of a certain as a vector of continuous tokens.

fn get_item_signature(&self, item_id: DocumentableItemId) -> Option<String>

Gets the signature of an item (i.e., item without its body).

fn get_item_signature_with_links( &self, item_id: DocumentableItemId, ) -> (Option<String>, Vec<LocationLink>)

Gets the signature of an item and a list of LocationLinks to enable mapping signature slices on documentable items.

Trait Implementations

impl DebugWithDb<dyn DocGroup> for CommentLinkToken

fn fmt(&self, f: &mut Formatter<'_>, db: &dyn DocGroup) -> Result

fn debug<'me, 'db>(&'me self, db: &'me Db) -> DebugWith<'me, Db>

where Self: Sized + 'me,

fn into_debug<'me, 'db>(self, db: &'me Db) -> DebugWith<'me, Db>

where Self: Sized + 'me,

Implementors

impl<DB> DocGroup for DB

where DB: SemanticGroup + Upcast<dyn SemanticGroup> + Database + HasQueryGroup<DocDatabase>,