From 816ca9ed5db5b42c19dd9e53e3af903e8efec00b Mon Sep 17 00:00:00 2001
From: Edward Barnard
Date: Thu, 24 Dec 2015 19:37:13 +0000
Subject: Add some information about PlistEvent

---
 src/lib.rs | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

(limited to 'src')

diff --git a/src/lib.rs b/src/lib.rs
index 8a5d747..682b11c 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -135,6 +135,20 @@ impl Plist {
     }
 }
 
+/// An encoding of a plist as a flat structure.
+///
+/// Output by the event readers.
+///
+/// Dictionary keys and values are represented as pairs of values e.g.:
+///
+/// ```ignore rust
+/// StartDictionary
+/// StringValue("Height") // Key
+/// RealValue(181.2)      // Value
+/// StringValue("Age")    // Key
+/// IntegerValue(28)      // Value
+/// EndDictionary
+/// ```
 #[derive(Clone, Debug, PartialEq)]
 pub enum PlistEvent {
     StartPlist,
-- 
cgit v1.2.3