Struct TsDocExtensions 

pub struct TsDocExtensions {
    pub is_alpha: bool,
    pub is_beta: bool,
    pub is_package_doc: bool,
    pub remarks: Option<String>,
    pub private_remarks: Option<String>,
    pub default_values: Vec<(String, String)>,
    pub type_params: Vec<(String, Option<String>)>,
    pub is_override: bool,
    pub is_virtual: bool,
    pub is_sealed: bool,
    pub inherit_doc: Option<String>,
    pub is_event_property: bool,
}

@acp:summary “TSDoc-specific fields extending ParsedDocumentation”

Fields

is_alpha: bool

@alpha modifier - unstable API

is_beta: bool

@beta modifier - preview API

is_package_doc: bool

@packageDocumentation - file/module level doc

remarks: Option<String>

@remarks - extended description

private_remarks: Option<String>

@privateRemarks - internal notes (not exported)

default_values: Vec<(String, String)>

@defaultValue entries

type_params: Vec<(String, Option<String>)>

@typeParam entries: (name, description)

is_override: bool

@override modifier

is_virtual: bool

@virtual modifier

is_sealed: bool

@sealed modifier

inherit_doc: Option<String>

{@inheritDoc Target} references

is_event_property: bool

@eventProperty modifier

Trait Implementations

impl Clone for TsDocExtensions

fn clone(&self) -> TsDocExtensions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TsDocExtensions

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

Formats the value using the given formatter.

impl Default for TsDocExtensions

fn default() -> TsDocExtensions

Returns the “default value” for a type.