Struct deno_doc::html::jsdoc::ModuleDocCtx

pub struct ModuleDocCtx {
    pub title: Option<String>,
    pub deprecated: Option<String>,
    pub usages: Option<UsagesCtx>,
    pub examples: Option<SectionCtx>,
    pub docs: Option<Markdown>,
}

Fields

title: Option<String>

deprecated: Option<String>

usages: Option<UsagesCtx>

examples: Option<SectionCtx>

docs: Option<Markdown>

Implementations

impl ModuleDocCtx

pub fn new( render_ctx: &RenderContext<'_>, specifier: &ModuleSpecifier, doc_nodes_by_url: &IndexMap<ModuleSpecifier, Vec<DocNode>> ) -> Self

Trait Implementations

impl Clone for ModuleDocCtx

fn clone(&self) -> ModuleDocCtx

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ModuleDocCtx

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

Formats the value using the given formatter.

impl Default for ModuleDocCtx

fn default() -> ModuleDocCtx

Returns the “default value” for a type.

impl Serialize for ModuleDocCtx

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.