aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugin.rs
diff options
context:
space:
mode:
Diffstat (limited to 'src/plugin.rs')
-rw-r--r--src/plugin.rs4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/plugin.rs b/src/plugin.rs
index d2338f9..d14c129 100644
--- a/src/plugin.rs
+++ b/src/plugin.rs
@@ -1,3 +1,4 @@
+//! Definitions required for every `Plugin`
use std::fmt;
use irc::client::prelude::*;
@@ -14,7 +15,8 @@ pub trait Plugin: PluginName + Send + Sync + fmt::Debug {
fn command(&self, server: &IrcServer, command: PluginCommand) -> Result<(), IrcError>;
}
-/// `PluginName` is required by `Plugin`.
+/// `PluginName` is required by `Plugin`.
+///
/// To implement it simply add `#[derive(PluginName)]`
/// above the definition of the struct.
///