Enum jsdoc::ast::Tag

source · [−]

#[non_exhaustive]
pub enum Tag {
Show 67 variants
    Yield(YieldTag),
    TypeDef(TypeDefTag),
    Throw(ThrowTag),
    Todo(TodoTag),
    Tutorial(TutorialTag),
    Static(StaticTag),
    Summary(SummaryTag),
    See(SeeTag),
    Since(SinceTag),
    Requires(RequiresTag),
    Override(OverrideTag),
    Package(PackageTag),
    Module(ModuleTag),
    Name(NameTag),
    Namespace(NamespaceTag),
    Variation(VariationTag),
    Version(VersionTag),
    MemberOf(MemberOfTag),
    Mixes(MixesTag),
    Mixin(MixinTag),
    Member(MemberTag),
    Listens(ListensTag),
    License(LicenseTag),
    Kind(KindTag),
    Lends(LendsTag),
    Instance(InstanceTag),
    Interface(InterfaceTag),
    Inner(InnerTag),
    InheritDoc(InheritDocTag),
    Ignore(IgnoreTag),
    HideConstructor(HideConstructorTag),
    Generator(GeneratorTag),
    Function(FunctionTag),
    File(FileTag),
    Constructs(ConstructsTag),
    Copyright(CopyrightTag),
    Abstract(AbstractTag),
    Access(AccessTag),
    Alias(AliasTag),
    Async(AsyncTag),
    Unknown(UnknownTag),
    Augments(AugmentsTag),
    Implements(ImplementsTag),
    Author(AuthorTag),
    Borrows(BorrowsTag),
    Class(ClassTag),
    ClassDesc(JSDocClassDescTag),
    Const(ConstTag),
    Public(PublicTag),
    Private(PrivateTag),
    Protected(ProtectedTag),
    Readonly(ReadonlyTag),
    Callback(CallbackTag),
    Enum(EnumTag),
    Parameter(ParameterTag),
    Return(ReturnTag),
    This(ThisTag),
    Type(TypeTag),
    Template(TemplateTag),
    Typedef(TypedefTag),
    Property(PropertyTag),
    Description(DescriptionTag),
    Example(ExampleTag),
    Exports(ExportsTag),
    External(ExternalTag),
    Default(DefaultTag),
    Deprecated(DeprecatedTag),
}

Variants (Non-exhaustive)

This enum is marked as non-exhaustive

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

`Yield(YieldTag)`

`TypeDef(TypeDefTag)`

`Throw(ThrowTag)`

`Todo(TodoTag)`

`Tutorial(TutorialTag)`

`Static(StaticTag)`

`Summary(SummaryTag)`

`See(SeeTag)`

`Since(SinceTag)`

`Requires(RequiresTag)`

`Override(OverrideTag)`

`Package(PackageTag)`

`Module(ModuleTag)`

`Name(NameTag)`

`Namespace(NamespaceTag)`

`Variation(VariationTag)`

`Version(VersionTag)`

`MemberOf(MemberOfTag)`

`Mixes(MixesTag)`

`Mixin(MixinTag)`

`Member(MemberTag)`

`Listens(ListensTag)`

`License(LicenseTag)`

`Kind(KindTag)`

`Lends(LendsTag)`

`Instance(InstanceTag)`

`Interface(InterfaceTag)`

`Inner(InnerTag)`

`InheritDoc(InheritDocTag)`

`Ignore(IgnoreTag)`

`HideConstructor(HideConstructorTag)`

`Generator(GeneratorTag)`

`Function(FunctionTag)`

`File(FileTag)`

`Constructs(ConstructsTag)`

`Copyright(CopyrightTag)`

`Abstract(AbstractTag)`

`Access(AccessTag)`

`Alias(AliasTag)`

`Async(AsyncTag)`

`Unknown(UnknownTag)`

`Augments(AugmentsTag)`

`Implements(ImplementsTag)`

`Author(AuthorTag)`

`Borrows(BorrowsTag)`

`Class(ClassTag)`

`ClassDesc(JSDocClassDescTag)`

`Const(ConstTag)`

`Public(PublicTag)`

`Private(PrivateTag)`

`Protected(ProtectedTag)`

`Readonly(ReadonlyTag)`

`Callback(CallbackTag)`

`Enum(EnumTag)`

`Parameter(ParameterTag)`

`Return(ReturnTag)`

`This(ThisTag)`

`Type(TypeTag)`

`Template(TemplateTag)`

`Typedef(TypedefTag)`

`Property(PropertyTag)`

`Description(DescriptionTag)`

`Example(ExampleTag)`

`Exports(ExportsTag)`

`External(ExternalTag)`

`Default(DefaultTag)`

`Deprecated(DeprecatedTag)`

Trait Implementations

source

impl Clone for Tag

source

fn clone(&self) -> Tag

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Tag

source

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

Formats the value using the given formatter. Read more

source

impl<'de> Deserialize<'de> for Tag

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source