Struct DocComment 

pub struct DocComment {

    pub brief: Option<String>,
    pub description: String,
    pub details: Option<String>,
    pub params: Vec<(String, String)>,
    pub returns: Option<String>,
    pub retvals: Vec<String>,
    pub deprecated: Option<String>,
    pub see: Vec<String>,
    pub since: Option<String>,
    pub notes: Vec<String>,
    pub warnings: Vec<String>,
    pub author: Option<String>,
    pub version: Option<String>,
    pub exceptions: Vec<String>,
    pub pre: Option<String>,
    pub post: Option<String>,
    pub sections: Vec<(String, String)>,
    pub complexity: Option<u8>,
    pub class_name: Option<String>,
    pub file: Option<String>,
    pub copyright: Option<String>,
    pub license: Option<String>,
    pub todos: Vec<String>,
    pub invariants: Vec<String>,
    pub date: Option<String>,
}

Structured documentation parsed from a Doxygen-style comment.

Fields

brief: Option<String>

Short summary (e.g. from @brief or first line).

description: String

Main description body.

details: Option<String>

Extended description from @details (multi-line).

params: Vec<(String, String)>

Parameter name -> description.

returns: Option<String>

Return value description.

retvals: Vec<String>

Per-value return descriptions from @retval.

deprecated: Option<String>

Deprecation message if @deprecated is present.

see: Vec<String>

@see references.

since: Option<String>

@since version or similar.

notes: Vec<String>

@note items.

warnings: Vec<String>

@warning items.

author: Option<String>

@author.

version: Option<String>

@version.

exceptions: Vec<String>

@exception / @throws descriptions.

pre: Option<String>

@pre precondition.

post: Option<String>

@post postcondition.

sections: Vec<(String, String)>

Named sections from @par Title (and optional @code blocks). (title, content).

complexity: Option<u8>

Complexity code 1–13 from @complexity (e.g. in .sig files). See crate::analysis::complexity_display_string.

class_name: Option<String>

@class class name (for class documentation).

file: Option<String>

@file source file name.

copyright: Option<String>

@copyright notice.

license: Option<String>

@license notice.

todos: Vec<String>

@todo items.

invariants: Vec<String>

@invariant items.

date: Option<String>

@date date string.

Trait Implementations

impl Clone for DocComment

fn clone(&self) -> DocComment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocComment

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

Formats the value using the given formatter.

impl Default for DocComment

fn default() -> DocComment

Returns the “default value” for a type.