From 8aee739706222e67803b784257b7878a68ce84ac Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Fri, 20 Dec 2019 11:14:29 +0100 Subject: Add crate top-level documentation Signed-off-by: Matthias Beyer --- src/lib.rs | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/lib.rs b/src/lib.rs index 71579d8..d0fc056 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -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; + -- cgit v1.2.3