Struct RoxygenTag 

pub struct RoxygenTag(/* private fields */);

Implementations

impl RoxygenTag

pub fn at(&self) -> Option<SyntaxToken<RLanguage>>

The @ token.

pub fn name(&self) -> Option<SmolStr>

The tag name (e.g. param, examples), without the leading @.

pub fn arg(&self) -> Option<SyntaxToken<RLanguage>>

The name argument for arg-bearing tags (e.g. x in @param x ...).

pub fn text(&self) -> Option<SyntaxToken<RLanguage>>

The remaining prose content of the tag, if any.

pub fn value_text(&self) -> Option<String>

The tag’s whole same-line value, with the roxygen markers dropped and the ends trimmed: every token after the tag head (@name, plus the arg token for an arg-bearing tag), joined.

RoxygenTag::text returns the first ROXYGEN_TEXT leaf alone, which under @md is only part of the value: an intraword _ or * is carved as an unresolved ROXYGEN_MD_DELIM, so @rdname missing_arg is three leaves. Reach for this whenever the value is a name rather than prose (@name, @rdname, @describeIn) — those tags never fold continuation lines, so their node spans exactly one line.

pub fn is_examples(&self) -> bool

Whether this is an @examples/@examplesIf tag (embedded R code).

pub fn arg_names(&self) -> Vec<(SmolStr, TextRange)>

The comma-separated names in the tag’s arg (@param a,b documents both a and b), each with the sub-range of its own text inside the arg token. Empty for a tag with no arg.

Trait Implementations

impl AstNode for RoxygenTag

type Language = RLanguage

fn can_cast(kind: SyntaxKind) -> bool

fn cast(syntax: SyntaxNode) -> Option<Self>

fn syntax(&self) -> &SyntaxNode

fn clone_subtree(&self) -> Self

where Self: Sized,

impl Clone for RoxygenTag

fn clone(&self) -> RoxygenTag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RoxygenTag

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

Formats the value using the given formatter.

impl Eq for RoxygenTag

impl Hash for RoxygenTag

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RoxygenTag

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RoxygenTag