Fixed Doc comment (hopfully for the last time)
They are strange indeed.
This commit is contained in:
commit
ef1e849d0e
2 changed files with 6 additions and 4 deletions
|
@ -15,6 +15,9 @@
|
||||||
* along with irc-stream. If not, see <https://www.gnu.org/licenses/>.
|
* along with irc-stream. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
//! Implements IrcStreamError, an error type
|
||||||
|
//! that wraps all possible error that are thrown by IrcStream.
|
||||||
|
|
||||||
use std::{
|
use std::{
|
||||||
error::Error,
|
error::Error,
|
||||||
fmt,
|
fmt,
|
||||||
|
@ -22,8 +25,6 @@ use std::{
|
||||||
str,
|
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.
|
/// A custom error type that wraps all error that IrcStream will throw.
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
pub enum IrcStreamError {
|
pub enum IrcStreamError {
|
||||||
|
|
|
@ -15,14 +15,15 @@
|
||||||
* along with irc-stream. If not, see <https://www.gnu.org/licenses/>.
|
* along with irc-stream. If not, see <https://www.gnu.org/licenses/>.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
//! This crate provides the `IrcRead` and `IrcWrite` traits and
|
||||||
|
//! the IrcStream struct that implements them.
|
||||||
|
|
||||||
pub mod error;
|
pub mod error;
|
||||||
|
|
||||||
pub use self::error::*;
|
pub use self::error::*;
|
||||||
use std::io::{Read, Write};
|
use std::io::{Read, Write};
|
||||||
use irc_proto::message::Message;
|
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;
|
/// A trait that mirrors std::io::Read;
|
||||||
/// It requires the `read()` method that returns an IRC Message.
|
/// It requires the `read()` method that returns an IRC Message.
|
||||||
/// The function may or may not block.
|
/// The function may or may not block.
|
||||||
|
|
Loading…
Reference in a new issue