[−][src]Enum jsdoc::ast::Tag

#[non_exhaustive]pub enum Tag {
    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(FilelTag),
    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)

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(FilelTag)

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

`impl Clone for Tag`[src]

`fn clone(&self) -> Tag`[src]

`fn clone_from(&mut self, source: &Self)`1.0.0[src]

`impl Debug for Tag`[src]

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

`impl<'de> Deserialize<'de> for Tag`[src]

`fn deserialize<D>(Deserializer: D) -> Result<Self, D::Error> where D: Deserializer<'de>,` [src]

`impl From<AbstractTag> for Tag`[src]

`fn from(v: AbstractTag) -> Self`[src]

`impl From<AccessTag> for Tag`[src]

`fn from(v: AccessTag) -> Self`[src]

`impl From<AliasTag> for Tag`[src]

`fn from(v: AliasTag) -> Self`[src]

`impl From<AsyncTag> for Tag`[src]

`fn from(v: AsyncTag) -> Self`[src]

`impl From<AugmentsTag> for Tag`[src]

`fn from(v: AugmentsTag) -> Self`[src]

`impl From<AuthorTag> for Tag`[src]

`fn from(v: AuthorTag) -> Self`[src]

`impl From<BorrowsTag> for Tag`[src]

`fn from(v: BorrowsTag) -> Self`[src]

`impl From<CallbackTag> for Tag`[src]

`fn from(v: CallbackTag) -> Self`[src]

`impl From<ClassTag> for Tag`[src]

`fn from(v: ClassTag) -> Self`[src]

`impl From<ConstTag> for Tag`[src]

`fn from(v: ConstTag) -> Self`[src]

`impl From<ConstructsTag> for Tag`[src]

`fn from(v: ConstructsTag) -> Self`[src]

`impl From<CopyrightTag> for Tag`[src]

`fn from(v: CopyrightTag) -> Self`[src]

`impl From<DefaultTag> for Tag`[src]

`fn from(v: DefaultTag) -> Self`[src]

`impl From<DeprecatedTag> for Tag`[src]

`fn from(v: DeprecatedTag) -> Self`[src]

`impl From<DescriptionTag> for Tag`[src]

`fn from(v: DescriptionTag) -> Self`[src]

`impl From<EnumTag> for Tag`[src]

`fn from(v: EnumTag) -> Self`[src]

`impl From<ExampleTag> for Tag`[src]

`fn from(v: ExampleTag) -> Self`[src]

`impl From<ExportsTag> for Tag`[src]

`fn from(v: ExportsTag) -> Self`[src]

`impl From<ExternalTag> for Tag`[src]

`fn from(v: ExternalTag) -> Self`[src]

`impl From<FilelTag> for Tag`[src]

`fn from(v: FilelTag) -> Self`[src]

`impl From<FunctionTag> for Tag`[src]

`fn from(v: FunctionTag) -> Self`[src]

`impl From<GeneratorTag> for Tag`[src]

`fn from(v: GeneratorTag) -> Self`[src]

`impl From<HideConstructorTag> for Tag`[src]

`fn from(v: HideConstructorTag) -> Self`[src]

`impl From<IgnoreTag> for Tag`[src]

`fn from(v: IgnoreTag) -> Self`[src]

`impl From<ImplementsTag> for Tag`[src]

`fn from(v: ImplementsTag) -> Self`[src]

`impl From<InheritDocTag> for Tag`[src]

`fn from(v: InheritDocTag) -> Self`[src]

`impl From<InnerTag> for Tag`[src]

`fn from(v: InnerTag) -> Self`[src]

`impl From<InstanceTag> for Tag`[src]

`fn from(v: InstanceTag) -> Self`[src]

`impl From<InterfaceTag> for Tag`[src]

`fn from(v: InterfaceTag) -> Self`[src]

`impl From<JSDocClassDescTag> for Tag`[src]

`fn from(v: JSDocClassDescTag) -> Self`[src]

`impl From<KindTag> for Tag`[src]

`fn from(v: KindTag) -> Self`[src]

`impl From<LendsTag> for Tag`[src]

`fn from(v: LendsTag) -> Self`[src]

`impl From<LicenseTag> for Tag`[src]

`fn from(v: LicenseTag) -> Self`[src]

`impl From<ListensTag> for Tag`[src]

`fn from(v: ListensTag) -> Self`[src]

`impl From<MemberOfTag> for Tag`[src]

`fn from(v: MemberOfTag) -> Self`[src]

`impl From<MemberTag> for Tag`[src]

`fn from(v: MemberTag) -> Self`[src]

`impl From<MixesTag> for Tag`[src]

`fn from(v: MixesTag) -> Self`[src]

`impl From<MixinTag> for Tag`[src]

`fn from(v: MixinTag) -> Self`[src]

`impl From<ModuleTag> for Tag`[src]

`fn from(v: ModuleTag) -> Self`[src]

`impl From<NameTag> for Tag`[src]

`fn from(v: NameTag) -> Self`[src]

`impl From<NamespaceTag> for Tag`[src]

`fn from(v: NamespaceTag) -> Self`[src]

`impl From<OverrideTag> for Tag`[src]

`fn from(v: OverrideTag) -> Self`[src]

`impl From<PackageTag> for Tag`[src]

`fn from(v: PackageTag) -> Self`[src]

`impl From<ParameterTag> for Tag`[src]

`fn from(v: ParameterTag) -> Self`[src]

`impl From<PrivateTag> for Tag`[src]

`fn from(v: PrivateTag) -> Self`[src]

`impl From<PropertyTag> for Tag`[src]

`fn from(v: PropertyTag) -> Self`[src]

`impl From<ProtectedTag> for Tag`[src]

`fn from(v: ProtectedTag) -> Self`[src]

`impl From<PublicTag> for Tag`[src]

`fn from(v: PublicTag) -> Self`[src]

`impl From<ReadonlyTag> for Tag`[src]

`fn from(v: ReadonlyTag) -> Self`[src]

`impl From<RequiresTag> for Tag`[src]

`fn from(v: RequiresTag) -> Self`[src]

`impl From<ReturnTag> for Tag`[src]

`fn from(v: ReturnTag) -> Self`[src]

`impl From<SeeTag> for Tag`[src]

`fn from(v: SeeTag) -> Self`[src]

`impl From<SinceTag> for Tag`[src]

`fn from(v: SinceTag) -> Self`[src]

`impl From<StaticTag> for Tag`[src]

`fn from(v: StaticTag) -> Self`[src]

`impl From<SummaryTag> for Tag`[src]

`fn from(v: SummaryTag) -> Self`[src]

`impl From<TemplateTag> for Tag`[src]

`fn from(v: TemplateTag) -> Self`[src]

`impl From<ThisTag> for Tag`[src]

`fn from(v: ThisTag) -> Self`[src]

`impl From<ThrowTag> for Tag`[src]

`fn from(v: ThrowTag) -> Self`[src]

`impl From<TodoTag> for Tag`[src]

`fn from(v: TodoTag) -> Self`[src]

`impl From<TutorialTag> for Tag`[src]

`fn from(v: TutorialTag) -> Self`[src]

`impl From<TypeDefTag> for Tag`[src]

`fn from(v: TypeDefTag) -> Self`[src]

`impl From<TypeTag> for Tag`[src]

`fn from(v: TypeTag) -> Self`[src]

`impl From<TypedefTag> for Tag`[src]

`fn from(v: TypedefTag) -> Self`[src]

`impl From<UnknownTag> for Tag`[src]

`fn from(v: UnknownTag) -> Self`[src]

`impl From<VariationTag> for Tag`[src]

`fn from(v: VariationTag) -> Self`[src]

`impl From<VersionTag> for Tag`[src]

`fn from(v: VersionTag) -> Self`[src]

`impl From<YieldTag> for Tag`[src]

`fn from(v: YieldTag) -> Self`[src]

`impl PartialEq<Tag> for Tag`[src]

`fn eq(&self, other: &Tag) -> bool`[src]

`fn ne(&self, other: &Tag) -> bool`[src]

`impl Serialize for Tag`[src]

`fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where S: Serializer,` [src]

`impl Spanned for Tag`[src]

`fn span(&self) -> Span`[src]

`impl StructuralPartialEq for Tag`[src]

Auto Trait Implementations

`impl RefUnwindSafe for Tag`

`impl Send for Tag`

`impl Sync for Tag`

`impl Unpin for Tag`

`impl UnwindSafe for Tag`

Blanket Implementations

`impl<T> Any for T where T: 'static + ?Sized,` [src]

`fn type_id(&self) -> TypeId`[src]

`impl<T> Borrow<T> for T where T: ?Sized,` [src]

`fn borrow(&self) -> &T`[src]

`impl<T> BorrowMut<T> for T where T: ?Sized,` [src]

`fn borrow_mut(&mut self) -> &mut T`[src]

`impl<T> DeserializeOwned for T where T: for<'de> Deserialize<'de>,` [src]

`impl<T> From<T> for T`[src]

`fn from(t: T) -> T`[src]

`impl<T, U> Into<U> for T where U: From<T>,` [src]

`fn into(self) -> U`[src]

`impl<T> Send for T where T: ?Sized,` [src]

`impl<T> Sync for T where T: ?Sized,` [src]

`impl<T> ToOwned for T where T: Clone,` [src]

`type Owned = T`

The resulting type after obtaining ownership.

`fn to_owned(&self) -> T`[src]

`fn clone_into(&self, target: &mut T)`[src]

`impl<T, U> TryFrom<U> for T where U: Into<T>,` [src]

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

`impl<T, U> TryInto<U> for T where U: TryFrom<T>,` [src]

`type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]