Trait DocGroup 

pub trait DocGroup: Database {
    // Provided methods
    fn get_item_documentation<'db>(
        &'db self,
        item_id: DocumentableItemId<'db>,
    ) -> Option<String> { ... }
    fn get_item_documentation_as_tokens<'db>(
        &'db self,
        item_id: DocumentableItemId<'db>,
    ) -> Option<Vec<DocumentationCommentToken<'db>>> { ... }
    fn get_item_signature<'db>(
        &'db self,
        item_id: DocumentableItemId<'db>,
    ) -> Option<String> { ... }
    fn get_item_signature_with_links<'db>(
        &'db self,
        item_id: DocumentableItemId<'db>,
    ) -> (Option<String>, Vec<LocationLink<'db>>) { ... }
}

Provided Methods

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

Gets the documentation of an item.

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

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

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

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

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

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

Implementors

impl<T: Database + ?Sized> DocGroup for T