Struct TagDescriptions 

pub struct TagDescriptions {
    pub params: Vec<(Arc<str>, Arc<str>)>,
    pub returns: Option<Arc<str>>,
    pub throws: Vec<(Arc<str>, Arc<str>)>,
}

Prose following the type and name of @param, @return and @throws tags. Tags without prose are omitted.

Fields

params: Vec<(Arc<str>, Arc<str>)>

(parameter name without $, description).

returns: Option<Arc<str>>

throws: Vec<(Arc<str>, Arc<str>)>

(resolved exception FQCN, description).

Trait Implementations

impl Clone for TagDescriptions

fn clone(&self) -> TagDescriptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TagDescriptions

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

Formats the value using the given formatter.

impl Default for TagDescriptions

fn default() -> TagDescriptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TagDescriptions

fn deserialize<__D>( __deserializer: __D, ) -> Result<TagDescriptions, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for TagDescriptions

impl PartialEq for TagDescriptions

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for TagDescriptions

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TagDescriptions