From c7f1af90b262a597af2051717fb29a63c60a08e5 Mon Sep 17 00:00:00 2001 From: Erick Tryzelaar Date: Tue, 1 Sep 2015 18:13:14 -0700 Subject: [PATCH] Document serde::iter --- serde/src/iter.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/serde/src/iter.rs b/serde/src/iter.rs index aa906666..24a6bf30 100644 --- a/serde/src/iter.rs +++ b/serde/src/iter.rs @@ -1,8 +1,9 @@ -#![allow(missing_docs)] +//! Module that contains helper iterators. use std::io; use std::iter::Peekable; +/// Iterator over a byte stream that tracks the current position's line and column. pub struct LineColIterator>> { iter: Iter, line: usize, @@ -10,6 +11,7 @@ pub struct LineColIterator>> { } impl>> LineColIterator { + /// Construct a new `LineColIterator`. pub fn new(iter: Iter) -> LineColIterator { LineColIterator { iter: iter,