diff options
author | Markus Unterwaditzer <markus@unterwaditzer.net> | 2015-01-11 11:46:16 +0100 |
---|---|---|
committer | Markus Unterwaditzer <markus@unterwaditzer.net> | 2015-01-11 11:46:16 +0100 |
commit | d6c68c8956fe725ab31a50f82092d8c9e6792976 (patch) | |
tree | ac6592aad2a62bee603207578bc3630016931228 | |
parent | 4603830a96b0c8216c4de3235b91f6379b57fdb4 (diff) |
Nicer docstring syntax
https://www.reddit.com/r/rust/comments/2ryij9/rustvobject_a_vcardicalendar_parser_for_rust/cnkjj2t
-rw-r--r-- | src/vobject/lib.rs | 32 |
1 files changed, 15 insertions, 17 deletions
diff --git a/src/vobject/lib.rs b/src/vobject/lib.rs index 0a84b4c..4658640 100644 --- a/src/vobject/lib.rs +++ b/src/vobject/lib.rs @@ -23,23 +23,23 @@ impl Property { } } - #[doc="Get property group. E.g. a contentline like `foo.FN:Markus` would result in the group \ - being `\"foo\"`."] + /// Get property group. E.g. a contentline like `foo.FN:Markus` would result in the group being + /// `"foo"`. pub fn get_prop_group(&self) -> &Option<String> { &self.prop_group } - #[doc="Get parameters."] + /// Get parameters. pub fn get_params(&self) -> &HashMap<String, String> { &self.params } - #[doc="Get value as unparsed string."] + /// Get value as unparsed string. pub fn get_raw_value(&self) -> &String { &self.raw_value } - #[doc="Get value as unescaped string."] + /// Get value as unescaped string. pub fn value_as_string(&self) -> String { unescape_chars(self.get_raw_value()) } @@ -47,13 +47,13 @@ impl Property { pub struct Component { - #[doc="The name of the component, such as `VCARD` or `VEVENT`."] + /// The name of the component, such as `VCARD` or `VEVENT`. pub name: String, - #[doc="The component's properties."] + /// The component's properties. pub props: HashMap<String, Vec<Property>>, - #[doc="The component's child- or sub-components."] + /// The component's child- or sub-components. pub subcomponents: Vec<Component> } @@ -66,8 +66,7 @@ impl Component { } } - #[doc="Retrieve one property (from many) by key. - Returns `None` if nothing is found."] + /// Retrieve one property (from many) by key. Returns `None` if nothing is found. pub fn single_prop(&self, key: &str) -> Option<&Property> { match self.props.get(key) { Some(x) => { @@ -80,8 +79,8 @@ impl Component { } } - #[doc="Retrieve a mutable vector of properties for this key. - Creates one (and inserts it into the component) if none exists."] + /// Retrieve a mutable vector of properties for this key. Creates one (and inserts it into the + /// component) if none exists. pub fn all_props_mut(&mut self, key: &str) -> &mut Vec<Property> { match self.props.entry(String::from_str(key)) { Occupied(values) => values.into_mut(), @@ -89,8 +88,7 @@ impl Component { } } - #[doc="Retrieve properties by key. - Returns an empty slice if key doesn't exist."] + /// Retrieve properties by key. Returns an empty slice if key doesn't exist. pub fn all_props(&self, key: &str) -> &[Property] { static EMPTY: &'static [Property] = &[]; match self.props.get(key) { @@ -204,7 +202,7 @@ __ = (eol / whitespace)* "#); -#[doc="Parse a component. The error value is a human-readable message."] +/// Parse a component. The error value is a human-readable message. pub fn parse_component(s: &String) -> Result<Component, String> { // XXX: The unfolding should be worked into the PEG // See feature request: https://github.com/kevinmehall/rust-peg/issues/26 @@ -216,7 +214,7 @@ pub fn parse_component(s: &String) -> Result<Component, String> { parser::component(unfolded.as_slice()) } -#[doc="Escape text for a VObject property value."] +/// Escape text for a VObject property value. pub fn escape_chars(s: &String) -> String { // Order matters! Lifted from icalendar.parser // https://github.com/collective/icalendar/ @@ -229,7 +227,7 @@ pub fn escape_chars(s: &String) -> String { .replace("\n", "\\n") } -#[doc="Unescape text from a VObject property value."] +/// Unescape text from a VObject property value. pub fn unescape_chars(s: &String) -> String { // Order matters! Lifted from icalendar.parser // https://github.com/collective/icalendar/ |