Made documentation improvements.
This commit is contained in:
parent
95234df31f
commit
3f0c3ba175
3 changed files with 3 additions and 2 deletions
|
@ -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};
|
||||||
|
|
|
@ -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>,
|
||||||
|
|
|
@ -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;
|
||||||
|
|
Loading…
Reference in a new issue