Made documentation improvements.

This commit is contained in:
Aaron Weiss 2014-11-08 23:21:55 -05:00
parent 95234df31f
commit 3f0c3ba175
3 changed files with 3 additions and 2 deletions

View file

@ -1,4 +1,4 @@
//! Thread-safe connections on any IrcWriters and IrcReaders. //! Thread-safe connections on IrcStreams.
#![experimental] #![experimental]
use std::sync::{Mutex, MutexGuard}; use std::sync::{Mutex, MutexGuard};
use std::io::{BufferedStream, IoResult, MemWriter, TcpStream}; use std::io::{BufferedStream, IoResult, MemWriter, TcpStream};

View file

@ -24,6 +24,7 @@ pub struct Config {
/// The port to connect on. /// The port to connect on.
pub port: u16, pub port: u16,
/// Whether or not to use SSL. /// Whether or not to use SSL.
/// Bots will automatically panic if this is enabled without SSL support.
pub use_ssl: bool, pub use_ssl: bool,
/// A list of channels to join on connection. /// A list of channels to join on connection.
pub channels: Vec<String>, pub channels: Vec<String>,

View file

@ -1,5 +1,5 @@
//! Data related to IRC functionality. //! Data related to IRC functionality.
#![experimental] #![unstable]
pub use data::config::Config; pub use data::config::Config;
pub use data::message::Message; pub use data::message::Message;