From 07e3a81e0183912fe453ada4194b4e7a1d3c39ec Mon Sep 17 00:00:00 2001
From: ntrifunovic <ntrifunovic@a809a056-fc17-0410-9590-b4f493f8b08e>
Date: Sun, 20 Feb 2011 18:33:36 +0000
Subject: [PATCH] Fix for ID: 3185087 - utf8::prior and utf8::previous
 documentation issue

git-svn-id: http://svn.code.sf.net/p/utfcpp/code@118 a809a056-fc17-0410-9590-b4f493f8b08e
---
 doc/utf8cpp.html | 10 +++++++---
 1 file changed, 7 insertions(+), 3 deletions(-)

diff --git a/doc/utf8cpp.html b/doc/utf8cpp.html
index 3f04ce2..c0a89a2 100644
--- a/doc/utf8cpp.html
+++ b/doc/utf8cpp.html
@@ -441,7 +441,9 @@ assert (w == twochars);
       This function has two purposes: one is two iterate backwards through a UTF-8
       encoded string. Note that it is usually a better idea to iterate forward instead,
       since <code>utf8::next</code> is faster. The second purpose is to find a beginning
-      of a UTF-8 sequence if we have a random position within a string.
+      of a UTF-8 sequence if we have a random position within a string. Note that in that
+      case <code>utf8::prior</code> may not detect an invalid UTF-8 sequence in some scenarios:
+      for instance if there are superfluous trail octets, it will just skip them.
     </p> 
     <p>
       <code>it</code> will typically point to the beginning of
@@ -451,10 +453,12 @@ assert (w == twochars);
       beginning with that octet is decoded to a 32 bit representation and returned.
     </p>
     <p>
-      In case <code>pass_end</code> is reached before a UTF-8 lead octet is hit, or if an
+      In case <code>start</code> is reached before a UTF-8 lead octet is hit, or if an
       invalid UTF-8 sequence is started by the lead octet, an <code>invalid_utf8</code>
       exception is thrown.
     </p>
+    <p>In case <code>start</code> equals <code>it</code>, a <code>not_enough_room</code>
+      exception is thrown.
     <h4>
       utf8::previous
     </h4>
@@ -512,7 +516,7 @@ assert (w == twochars);
       beginning with that octet is decoded to a 32 bit representation and returned.
     </p>
     <p>
-      In case <code>pass_end</code> is reached before a UTF-8 lead octet is hit, or if an
+      In case <code>pass_start</code> is reached before a UTF-8 lead octet is hit, or if an
       invalid UTF-8 sequence is started by the lead octet, an <code>invalid_utf8</code>
       exception is thrown
     </p>