From 92ea5a1c2e0b7ddaa102d6b602d180e84964c3be Mon Sep 17 00:00:00 2001 From: Jokler Date: Fri, 15 Dec 2017 19:29:40 +0100 Subject: Adjust documentation --- src/plugin.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) (limited to 'src/plugin.rs') 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. /// -- cgit v1.2.3-70-g09d2