diff --git a/src/error.rs b/src/error.rs index 4f0e79e..23e546c 100644 --- a/src/error.rs +++ b/src/error.rs @@ -15,6 +15,9 @@ * along with irc-stream. If not, see . */ +//! Implements IrcStreamError, an error type +//! that wraps all possible error that are thrown by IrcStream. + use std::{ error::Error, fmt, @@ -22,8 +25,6 @@ use std::{ str, }; -//! Implements IrcStreamError, an error type -//! that wraps all possible error that are thrown by IrcStream. /// A custom error type that wraps all error that IrcStream will throw. #[derive(Debug)] pub enum IrcStreamError { diff --git a/src/lib.rs b/src/lib.rs index d8c8879..0475f06 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -15,14 +15,15 @@ * along with irc-stream. If not, see . */ +//! This crate provides the `IrcRead` and `IrcWrite` traits and +//! the IrcStream struct that implements them. + pub mod error; pub use self::error::*; use std::io::{Read, Write}; use irc_proto::message::Message; -//! This crate provides the `IrcRead` and `IrcWrite` traits and -//! the IrcStream struct that implements them. /// A trait that mirrors std::io::Read; /// It requires the `read()` method that returns an IRC Message. /// The function may or may not block.