Struct PhpDoc 

#[non_exhaustive]
pub struct PhpDoc {
    pub summary: Option<PhpDocText>,
    pub description: Option<PhpDocText>,
    pub tags: Vec<PhpDocTag>,
    pub span: Span,
}

A parsed docblock.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

summary: Option<PhpDocText>

Leading summary text.

description: Option<PhpDocText>

Description following the summary.

tags: Vec<PhpDocTag>

Block-level tags in source order.

span: Span

Always Span::new(0, text.len() as u32).

Trait Implementations

impl Clone for PhpDoc

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PhpDoc

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

Formats the value using the given formatter.

impl Serialize for PhpDoc

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

where __S: Serializer,

Serialize this value into the given Serde serializer.