From 42b75a755113b9e632222d8da64f73d5bdd2d36b Mon Sep 17 00:00:00 2001
From: Alex Helfet <alex.helfet@gmail.com>
Date: Thu, 28 Dec 2017 16:45:47 +0000
Subject: [PATCH] Doc comment for FRAME_END_SYMBOL.

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

diff --git a/framed/src/lib.rs b/framed/src/lib.rs
index eae45de..1a34b42 100644
--- a/framed/src/lib.rs
+++ b/framed/src/lib.rs
@@ -173,6 +173,11 @@ impl Deref for BoxEncoded {
     }
 }
 
+/// The frame ends with (and includes) this byte.
+///
+/// Consumers can read encoded data into a buffer until they encounter
+/// this value and then use one of the `decode_*` functions to decode
+/// the frame's payload.
 pub const FRAME_END_SYMBOL: u8 = 0;
 
 const HEADER_LEN: usize = 0;