[zbar-commits] push rev [281]: iPhone: fix doc typo (bug #3139087)

[<sp...@us...>]

changeset: 281:a2b6e0e1d504
user:      sp...@us...
date:      Tue Dec 28 13:26:36 2010 -0800
details:   http://zbar.hg.sourceforge.net:8000/hgroot/zbar/zbarzbar/rev/a2b6e0e1d504
description:
iPhone: fix doc typo (bug #3139087)
    - add modifier bit docs

diffstat:

 iphone/ChangeLog          |   4 ++++
 iphone/doc/ZBarSymbol.rst |  19 ++++++++++++++++++-
 iphone/doc/compat.rst     |   4 ++--
 iphone/doc/picker.rst     |   4 ++--
 python/README             |   3 ++-
 5 files changed, 28 insertions(+), 6 deletions(-)

diffs (92 lines):

diff -r c617889f8f73 -r a2b6e0e1d504 iphone/ChangeLog
--- a/iphone/ChangeLog	Mon Nov 29 14:48:55 2010 -0800
+++ b/iphone/ChangeLog	Tue Dec 28 13:26:36 2010 -0800
@@ -1,3 +1,7 @@
+current:
+  * fix doc typo (bug #3139087)
+    - add modifier bit docs
+
 version 1.0.1:
   * hotfix broken ZBarHelpController back button
   * release updates
diff -r c617889f8f73 -r a2b6e0e1d504 iphone/doc/ZBarSymbol.rst
--- a/iphone/doc/ZBarSymbol.rst	Mon Nov 29 14:48:55 2010 -0800
+++ b/iphone/doc/ZBarSymbol.rst	Tue Dec 28 13:26:36 2010 -0800
@@ -31,7 +31,8 @@
 
    .. member:: NSUInteger modifierMask
 
-      Bitmask of symbology characteristics detected during decode.
+      Bitmask of symbology characteristics detected during decode.  See
+      :type:`zbar_modifier_t` for the currently defined modifier bits.
 
    .. member:: NSString *data
 
@@ -164,3 +165,19 @@
 
    ZBAR_ORIENT_LEFT
       Sideways, read bottom to top
+
+.. type:: zbar_modifier_t
+
+   Decoder symbology modifier flags.
+
+   .. note::
+
+      These are bit indices, use eg, (1 << ZBAR_MOD_GS1) to test the
+      modifierMask property.
+
+   ZBAR_MOD_GS1
+      Barcode tagged as GS1 (EAN.UCC) reserved (eg, FNC1 before first data
+      character).  Data may be parsed as a sequence of GS1 AIs.
+
+   ZBAR_MOD_AIM
+      Barcode tagged as AIM reserved.
diff -r c617889f8f73 -r a2b6e0e1d504 iphone/doc/compat.rst
--- a/iphone/doc/compat.rst	Mon Nov 29 14:48:55 2010 -0800
+++ b/iphone/doc/compat.rst	Tue Dec 28 13:26:36 2010 -0800
@@ -153,7 +153,7 @@
 depending on whether the library was compiled to use private APIs::
 
    if(![ZBarReaderController isSourceTypeAvailable:
-                                 UIImagePickerControllerSoureTypeCamera]) {
+                                 UIImagePickerControllerSourceTypeCamera]) {
        // camera unavailable: display warning and abort
        // or resort to keypad entry, etc...
        return;
@@ -164,7 +164,7 @@
    // or a ZBarReaderViewController for iOS 4
    
    reader.readerDelegate = self;
-   reader.sourceType = UIImagePickerControllerSoureTypeCamera;
+   reader.sourceType = UIImagePickerControllerSourceTypeCamera;
    reader.showsZBarControls = YES;
    
    if(reader.cameraMode == ZBarReaderControllerCameraModeSampling) {
diff -r c617889f8f73 -r a2b6e0e1d504 iphone/doc/picker.rst
--- a/iphone/doc/picker.rst	Mon Nov 29 14:48:55 2010 -0800
+++ b/iphone/doc/picker.rst	Tue Dec 28 13:26:36 2010 -0800
@@ -28,8 +28,8 @@
    property::
 
       if([ZBarReaderController isSourceTypeAvailable:
-                                   UIImagePickerControllerSoureTypeCamera])
-          reader.sourceType = UIImagePickerControllerSoureTypeCamera;
+                                   UIImagePickerControllerSourceTypeCamera])
+          reader.sourceType = UIImagePickerControllerSourceTypeCamera;
       [reader.scanner setSymbology: ZBAR_I25
                       config: ZBAR_CFG_ENABLE
                       to: 0];
diff -r c617889f8f73 -r a2b6e0e1d504 python/README
--- a/python/README	Mon Nov 29 14:48:55 2010 -0800
+++ b/python/README	Tue Dec 28 13:26:36 2010 -0800
@@ -29,7 +29,8 @@
 * http://zbar.sourceforge.net/
 
 Windows users please note: the module *will NOT load* unless the ZBar
-library DLL (currently libzbar-0.dll) is available in your PATH!
+library DLL (currently libzbar-0.dll) is available in your Windows system
+PATH!
 
 Examples
 --------