Struct DocTag 

struct DocTag<'a> {
    default: bool,
    lines: Vec<&'a str>,
}

One roxygen tag of a class’s docs: its #' lines, the first opening the tag (#' @name ...), or the lines before the first tag. default marks a generated line (CLASS_DEFAULT_PREFIX, stripped from lines).

Fields

default: bool

lines: Vec<&'a str>

Implementations

impl<'a> DocTag<'a>

fn parse(text: &'a str) -> Vec<Self>

The tags of text, a run of roxygen lines: a tag runs from its #' @tag line to the next one, as roxygen2 reads it.

fn default_line(line: &'a str) -> Option<Self>

A head’s generated default line, as a one-line tag; None for any other line.

fn name(&self) -> &'a str

The tag’s name (title for #' @title ...), or "" before the first tag.

fn value(&self) -> String

The tag’s text after its name, continuation lines included.

fn replaces(&self, default: &DocTag<'_>) -> bool

Whether this tag replaces the generated default (a tag of the same name; for @param and @field, naming the same argument or field, and @inheritParams for any @param).

Trait Implementations

impl<'a> Clone for DocTag<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> PartialEq for DocTag<'a>

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

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for DocTag<'a>

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 32 bytes