cairo_lang_doc::db

Trait DocGroup

Source
pub trait DocGroup:
    Database
    + HasQueryGroup<DocDatabase>
    + Upcast<dyn DefsGroup>
    + Upcast<dyn SyntaxGroup>
    + SyntaxGroup {
    // Required methods
    fn get_item_documentation(
        &self,
        item_id: DocumentableItemId,
    ) -> Option<String>;
    fn get_item_signature(&self, item_id: DocumentableItemId) -> String;
}

Required Methods§

Source

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

Gets the documentation above an item definition.

Source

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

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

Implementors§

Source§

impl<DB> DocGroup for DB
where DB: Upcast<dyn DefsGroup> + Upcast<dyn SyntaxGroup> + SyntaxGroup + Database + HasQueryGroup<DocDatabase>,