Struct SignalDoc 

pub struct SignalDoc {
    pub symbol: Option<String>,
    pub annotations: Vec<SignalAnnotation>,
    pub params: Vec<DocParam>,
    pub returns: Option<DocReturns>,
    pub description: Vec<String>,
    pub since: Option<Version>,
    pub deprecated: Option<(Version, Option<String>)>,
}

Fields

symbol: Option<String>

annotations: Vec<SignalAnnotation>

params: Vec<DocParam>

returns: Option<DocReturns>

description: Vec<String>

since: Option<Version>

deprecated: Option<(Version, Option<String>)>

Implementations

impl SignalDoc

pub fn from_comment(comment: &Comment) -> Option<Self>

pub fn from_comment_for( comment: &Comment, type_name: &str, signal_name: &str, ) -> Option<Self>

Attach only if the doc symbol matches TypeName::signal-name.

Trait Implementations

impl Clone for SignalDoc

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 SignalDoc

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

Formats the value using the given formatter.

impl Serialize for SignalDoc

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

where __S: Serializer,

Serialize this value into the given Serde serializer.