Enum deno_doc::js_doc::JsDocTag

pub enum JsDocTag {
    Callback {
        name: String,
        doc: Option<String>,
    },
    Category {
        doc: Option<String>,
    },
    Constructor,
    Default {
        value: String,
        doc: Option<String>,
    },
    Deprecated {
        doc: Option<String>,
    },
    Enum {
        type_ref: String,
        doc: Option<String>,
    },
    Example {
        doc: Option<String>,
    },
    Extends {
        type_ref: String,
        doc: Option<String>,
    },
    Ignore,
    Module,
    Param {
        name: String,
        type_ref: Option<String>,
        optional: bool,
        default: Option<String>,
        doc: Option<String>,
    },
    Public,
    Private,
    Property {
        name: String,
        type_ref: String,
        doc: Option<String>,
    },
    Protected,
    ReadOnly,
    Return {
        type_ref: Option<String>,
        doc: Option<String>,
    },
    Tags {
        tags: Vec<String>,
    },
    Template {
        name: String,
        doc: Option<String>,
    },
    This {
        type_ref: String,
        doc: Option<String>,
    },
    TypeDef {
        name: String,
        type_ref: String,
        doc: Option<String>,
    },
    TypeRef {
        type_ref: String,
        doc: Option<String>,
    },
    Unsupported {
        value: String,
    },
}

Variants

Callback

Fields

name: String

doc: Option<String>

@callback Predicate comment

Category

Fields

doc: Option<String>

@category comment

Constructor

@constructor or @class

Default

Fields

value: String

doc: Option<String>

@default {value} comment

Deprecated

Fields

doc: Option<String>

@deprecated comment

Enum

Fields

type_ref: String

doc: Option<String>

@enum {type} comment

Example

Fields

doc: Option<String>

Extends

Fields

type_ref: String

doc: Option<String>

@extends {type} comment

Ignore

@ignore

Module

@module

Param

Fields

name: String

type_ref: Option<String>

optional: bool

default: Option<String>

doc: Option<String>

@param, @arg or argument, in format of @param {type} name comment or @param {type} [name=default] comment or @param {type} [name] comment

Public

@public

Private

@private

Property

Fields

name: String

type_ref: String

doc: Option<String>

@property {type} name comment or @prop {type} name comment

Protected

@protected

ReadOnly

@readonly

Return

Fields

type_ref: Option<String>

doc: Option<String>

@return {type} comment or @returns {type} comment

Tags

Fields

tags: Vec<String>

@tags allow-read, allow-write

Template

Fields

name: String

doc: Option<String>

@template T comment

This

Fields

type_ref: String

doc: Option<String>

@this {type} comment

TypeDef

Fields

name: String

type_ref: String

doc: Option<String>

@typedef {type} name comment

TypeRef

Fields

type_ref: String

doc: Option<String>

@type {type} comment

Unsupported

Fields

value: String

Trait Implementations

impl Clone for JsDocTag

fn clone(&self) -> JsDocTag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsDocTag

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JsDocTag

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<String> for JsDocTag

fn from(value: String) -> Self

Converts to this type from the input type.

impl PartialEq for JsDocTag

fn eq(&self, other: &JsDocTag) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for JsDocTag

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for JsDocTag

impl StructuralPartialEq for JsDocTag