diff options
author | Matthias Beyer <mail@beyermatthias.de> | 2019-12-20 11:14:29 +0100 |
---|---|---|
committer | Matthias Beyer <mail@beyermatthias.de> | 2019-12-20 11:14:29 +0100 |
commit | 8aee739706222e67803b784257b7878a68ce84ac (patch) | |
tree | d0a798bf0b4261384e8910e1479f5edae04bb46f | |
parent | db2fdf0c1f6f611bd0a8e574c4a455b0d74b3eca (diff) |
Add crate top-level documentation
Signed-off-by: Matthias Beyer <mail@beyermatthias.de>
-rw-r--r-- | src/lib.rs | 9 |
1 files changed, 9 insertions, 0 deletions
@@ -1,3 +1,11 @@ +//! libical high level interface +//! +//! This library offers a high-level interface for the widely used libical. It relies upon the +//! libical-sys crate, which is a thin rust layer over the libical C API. +//! It provides a safe interface to libical that is rather lower-level, as well as convenience +//! functionality build on this low-level interface for easy handling of icalendar data. +//! + #![warn(unused_extern_crates)] #![allow(clippy::redundant_closure)] // disable "redundant closure" lint @@ -48,3 +56,4 @@ pub use crate::timezone::IcalTimeZone; pub use crate::vcalendar::IcalEventIter; pub use crate::vcalendar::IcalVCalendar; pub use crate::vevent::IcalVEvent; + |