summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatthias Beyer <matthias.beyer@atos.net>2019-04-25 09:33:42 +0200
committerMatthias Beyer <matthias.beyer@atos.net>2019-04-25 09:33:42 +0200
commit6850e90c5402873970c39726b74b6bef442aa4cb (patch)
tree4a3f4a79b9aeb024370dbd11a6f9f7194b04fde8
parent9f8682bee94ee349aa5086bdab257f7ce5cfcdb1 (diff)
Add doc: v1::api::StdinWrapper
-rw-r--r--librepology/src/v1/api.rs10
1 files changed, 4 insertions, 6 deletions
diff --git a/librepology/src/v1/api.rs b/librepology/src/v1/api.rs
index 796b10e..b493209 100644
--- a/librepology/src/v1/api.rs
+++ b/librepology/src/v1/api.rs
@@ -26,12 +26,10 @@ pub trait Api {
}
-//
-// Api implemented for StdIn (via a Wrapper for interior mutability)
-//
-// This way we can read the data from stdin and process it
-//
-
+/// Wrapper for "stdin"
+///
+/// This way we can implement the `Api` trait for StdIn (via a Wrapper for interior mutability)
+/// This way we can read the data from stdin and process it.
pub struct StdinWrapper(RefCell<Stdin>);
impl From<Stdin> for StdinWrapper {