Struct doxygen_rs::ast::ParsedDoxygen

pub struct ParsedDoxygen {
    pub title: Option<NestedString>,
    pub brief: Option<NestedString>,
    pub description: Option<Vec<NestedString>>,
    pub warnings: Option<Vec<Warning>>,
    pub notes: Option<Vec<Note>>,
    pub params: Option<Vec<Param>>,
    pub deprecated: Option<Deprecated>,
    pub todos: Option<Vec<NestedString>>,
    pub returns: Option<Vec<Return>>,
    pub return_values: Option<Vec<ReturnValue>>,
}

Represents a parsed Doxygen comment.

Fields

title: Option<NestedString>

Title of the item being documented

brief: Option<NestedString>

A brief introduction to the item being documented.

description: Option<Vec<NestedString>>

A description of the item being documented.

warnings: Option<Vec<Warning>>

List of warnings of the item being documented.

notes: Option<Vec<Note>>

List of notes of the item being documented.

params: Option<Vec<Param>>

The parameters of the item being documented.

deprecated: Option<Deprecated>

Data about the deprecation status of the item being documented.

todos: Option<Vec<NestedString>>

List of _To Do_s of the item being documented.

returns: Option<Vec<Return>>

Description of the values being returned

return_values: Option<Vec<ReturnValue>>

Possible return values of the item being documented

Trait Implementations

impl Clone for ParsedDoxygen

fn clone(&self) -> ParsedDoxygen

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParsedDoxygen

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

Formats the value using the given formatter.