Struct DocComment 

pub struct DocComment {
    pub span: Span,
    pub summary: String,
    pub body: String,
    pub tags: Vec<DocTag>,
}

Fields

span: Span

summary: String

body: String

tags: Vec<DocTag>

Implementations

impl DocComment

pub fn is_empty(&self) -> bool

pub fn param_doc(&self, name: &str) -> Option<&str>

pub fn type_param_doc(&self, name: &str) -> Option<&str>

pub fn returns_doc(&self) -> Option<&str>

pub fn deprecated_doc(&self) -> Option<&str>

pub fn example_doc(&self) -> Option<&str>

pub fn since_doc(&self) -> Option<&str>

pub fn to_markdown(&self) -> 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.

impl<'de> Deserialize<'de> for DocComment

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for DocComment

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for DocComment

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for DocComment

impl StructuralPartialEq for DocComment