aboutsummaryrefslogtreecommitdiff
path: root/src/event.rs
diff options
context:
space:
mode:
authorDaniel Schadt <kingdread@gmx.de>2020-05-02 14:12:54 +0200
committerDaniel Schadt <kingdread@gmx.de>2020-05-02 14:12:54 +0200
commit69f8feb33465de6213963c1aadf955704bb83a08 (patch)
tree7a737d2718fbeb030365f49aeba02846881935f9 /src/event.rs
parentd3e0d1bd58115f581cae6441c863ba85805007ff (diff)
downloadevtclib-69f8feb33465de6213963c1aadf955704bb83a08.tar.gz
evtclib-69f8feb33465de6213963c1aadf955704bb83a08.tar.bz2
evtclib-69f8feb33465de6213963c1aadf955704bb83a08.zip
add more documentation
Diffstat (limited to 'src/event.rs')
-rw-r--r--src/event.rs5
1 files changed, 4 insertions, 1 deletions
diff --git a/src/event.rs b/src/event.rs
index 0ccbced..6dc6591 100644
--- a/src/event.rs
+++ b/src/event.rs
@@ -1,3 +1,6 @@
+//! Event definitions.
+//!
+//! This module contains the different types of events in their high-level form.
use super::raw;
use std::convert::TryFrom;
@@ -19,7 +22,7 @@ pub enum FromRawEventError {
/// A rusty enum for all possible combat events.
///
-/// This makes dealing with `CbtEvent` a bit saner (and safer).
+/// This makes dealing with [`CbtEvent`][raw::CbtEvent] a bit saner (and safer).
#[derive(Clone, Debug, PartialEq)]
pub enum EventKind {
// State change events