Skip to content

Commit 560b9d8

Browse files
committed
docs(value): document methods
1 parent 5bbf0b1 commit 560b9d8

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

src/value.rs

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ use std::string;
66
///
77
/// (The default value is represented as a string.)
88
pub trait Value {
9-
// set
9+
/// set sets the underlying value.
1010
fn set(&mut self, val: string::String) -> Result<(), string::String>;
1111

12-
// value
12+
/// value retrieves the current value as a String.
1313
fn value(&self) -> string::String;
1414

15-
// typ returns the type name as a string. By default,
16-
// all Values are assumed to be strings.
17-
//
15+
/// typ returns the type name as a string. By default,
16+
/// all Values are assumed to be strings.
17+
///
1818
fn typ(&self) -> &str {
1919
"String"
2020
}

0 commit comments

Comments
 (0)