Struct RoxygenSection 

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

Implementations

impl RoxygenSection

pub fn tag(&self) -> Option<RoxygenTag>

The tag heading this section, if it is a tag section (@details, …); the intro section has none.

pub fn paragraphs(&self) -> impl Iterator<Item = RoxygenParagraph> + '_

The prose paragraphs of this section, in source order.

pub fn has_prose(&self) -> bool

Whether the section carries any prose beyond the tag head: text folded onto the tag line (@param x A number.) or a continuation paragraph.

Trait Implementations

impl AstNode for RoxygenSection

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 RoxygenSection

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 RoxygenSection

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

Formats the value using the given formatter.

impl Eq for RoxygenSection

impl Hash for RoxygenSection

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 RoxygenSection

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RoxygenSection