Enum PhpDocTag 

pub enum PhpDocTag<'src> {
    Param {
        type_str: Option<&'src str>,
        name: Option<&'src str>,
        description: Option<Cow<'src, str>>,
    },
    Return {
        type_str: Option<&'src str>,
        description: Option<Cow<'src, str>>,
    },
    Var {
        type_str: Option<&'src str>,
        name: Option<&'src str>,
        description: Option<Cow<'src, str>>,
    },
    Throws {
        type_str: Option<&'src str>,
        description: Option<Cow<'src, str>>,
    },
    Deprecated {
        description: Option<Cow<'src, str>>,
    },
    Template {
        name: &'src str,
        bound: Option<&'src str>,
    },
    Extends {
        type_str: &'src str,
    },
    Implements {
        type_str: &'src str,
    },
    Method {
        signature: &'src str,
    },
    Property {
        type_str: Option<&'src str>,
        name: Option<&'src str>,
        description: Option<Cow<'src, str>>,
    },
    PropertyRead {
        type_str: Option<&'src str>,
        name: Option<&'src str>,
        description: Option<Cow<'src, str>>,
    },
    PropertyWrite {
        type_str: Option<&'src str>,
        name: Option<&'src str>,
        description: Option<Cow<'src, str>>,
    },
    See {
        reference: &'src str,
    },
    Link {
        url: &'src str,
    },
    Since {
        version: &'src str,
    },
    Author {
        name: &'src str,
    },
    Internal,
    InheritDoc,
    Assert {
        type_str: Option<&'src str>,
        name: Option<&'src str>,
    },
    TypeAlias {
        name: Option<&'src str>,
        type_str: Option<&'src str>,
    },
    ImportType {
        body: &'src str,
    },
    Suppress {
        rules: &'src str,
    },
    Pure,
    Readonly,
    Immutable,
    Mixin {
        class: &'src str,
    },
    TemplateCovariant {
        name: &'src str,
        bound: Option<&'src str>,
    },
    TemplateContravariant {
        name: &'src str,
        bound: Option<&'src str>,
    },
    Generic {
        tag: &'src str,
        body: Option<Cow<'src, str>>,
    },
}

A single PHPDoc tag (e.g. @param int $x The value).

Variants

Param

@param [type] $name [description]

Fields

type_str: Option<&'src str>

name: Option<&'src str>

description: Option<Cow<'src, str>>

Return

@return [type] [description]

Fields

type_str: Option<&'src str>

description: Option<Cow<'src, str>>

Var

@var [type] [$name] [description]

Fields

type_str: Option<&'src str>

name: Option<&'src str>

description: Option<Cow<'src, str>>

Throws

@throws [type] [description]

Fields

type_str: Option<&'src str>

description: Option<Cow<'src, str>>

Deprecated

@deprecated [description]

Fields

description: Option<Cow<'src, str>>

Template

@template T [of bound]

Fields

name: &'src str

bound: Option<&'src str>

Extends

@extends [type]

Fields

type_str: &'src str

Implements

@implements [type]

Fields

type_str: &'src str

Method

@method [static] [return_type] name(params) [description]

Fields

signature: &'src str

Property

@property [type] $name [description]

Fields

type_str: Option<&'src str>

name: Option<&'src str>

description: Option<Cow<'src, str>>

PropertyRead

@property-read [type] $name [description]

Fields

type_str: Option<&'src str>

name: Option<&'src str>

description: Option<Cow<'src, str>>

PropertyWrite

@property-write [type] $name [description]

Fields

type_str: Option<&'src str>

name: Option<&'src str>

description: Option<Cow<'src, str>>

See

@see [reference] [description]

Fields

reference: &'src str

Link

@link [url] [description]

Fields

url: &'src str

Since

@since [version] [description]

Fields

version: &'src str

Author

@author name [<email>]

Fields

name: &'src str

Internal

@internal

InheritDoc

@inheritdoc / {@inheritdoc}

Assert

@psalm-assert, @phpstan-assert — assert that a parameter has a type after the call.

Fields

type_str: Option<&'src str>

name: Option<&'src str>

TypeAlias

@psalm-type, @phpstan-type — local type alias (@type Foo = int|string).

Fields

name: Option<&'src str>

type_str: Option<&'src str>

ImportType

@psalm-import-type, @phpstan-import-type — import a type alias from another class.

Fields

body: &'src str

Suppress

@psalm-suppress, @phpstan-ignore-next-line, @phpstan-ignore — suppress diagnostics.

Fields

rules: &'src str

Pure

@psalm-pure, @psalm-immutable, @psalm-readonly — purity/immutability markers.

Readonly

@psalm-readonly, @readonly — marks a property as read-only.

Immutable

@psalm-immutable — marks a class as immutable.

Mixin

@mixin [class] — indicates the class delegates calls to another.

Fields

class: &'src str

TemplateCovariant

@template-covariant T [of bound]

Fields

name: &'src str

bound: Option<&'src str>

TemplateContravariant

@template-contravariant T [of bound]

Fields

name: &'src str

bound: Option<&'src str>

Generic

Any tag not specifically recognized: @tagname [body]

Fields

tag: &'src str

body: Option<Cow<'src, str>>

Trait Implementations

impl<'src> Debug for PhpDocTag<'src>

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

Formats the value using the given formatter.