From 6850e90c5402873970c39726b74b6bef442aa4cb Mon Sep 17 00:00:00 2001
From: Matthias Beyer <matthias.beyer@atos.net>
Date: Thu, 25 Apr 2019 09:33:42 +0200
Subject: Add doc: v1::api::StdinWrapper

---
 librepology/src/v1/api.rs | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)

(limited to 'librepology')

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 {
-- 
cgit v1.2.3