ide_db::documentation

Trait HasDocs

source
pub trait HasDocs: HasAttrs {
    // Required methods
    fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>;
    fn resolve_doc_path(
        self,
        db: &dyn HirDatabase,
        link: &str,
        ns: Option<Namespace>,
    ) -> Option<DocLinkDef>;
}

Required Methods§

source

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

Implementations on Foreign Types§

source§

impl HasDocs for Adt

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for AssocItem

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for Const

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for Enum

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for ExternCrateDecl

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for Field

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for Function

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for Impl

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for Macro

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for Module

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for Static

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for Struct

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for Trait

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for TraitAlias

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for TypeAlias

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for Union

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

source§

impl HasDocs for Variant

source§

fn docs(self, db: &dyn HirDatabase) -> Option<Documentation>

source§

fn resolve_doc_path( self, db: &dyn HirDatabase, link: &str, ns: Option<Namespace>, ) -> Option<DocLinkDef>

Implementors§