Morgan's cosmetic improvement to a translation, and equivalent for other translations...
[zxing.git] / csharp / DecodeHintType.cs
index 8bc3190..ec55fac 100755 (executable)
@@ -1,5 +1,5 @@
-/*\r
-* Copyright 2008 ZXing authors\r
+/*\r
+* Copyright 2007 ZXing authors\r
 *\r
 * Licensed under the Apache License, Version 2.0 (the "License");\r
 * you may not use this file except in compliance with the License.\r
 * See the License for the specific language governing permissions and\r
 * limitations under the License.\r
 */\r
+using System;\r
 namespace com.google.zxing\r
 {\r
-    using System;\r
-    using System.Text;\r
-\r
-    /// <summary> A class which wraps a 2D array of bytes. The default usage is signed. If you want to use it as a\r
-    /// unsigned container, it's up to you to do byteValue & 0xff at each location.\r
-    /// *\r
-    /// JAVAPORT: I'm not happy about the argument ordering throughout the file, as I always like to have\r
-    /// the horizontal component first, but this is for compatibility with the C++ code. The original\r
-    /// code was a 2D array of ints, but since it only ever gets assigned -1, 0, and 1, I'm going to use\r
-    /// less memory and go with bytes.\r
-    /// *\r
-    /// </summary>\r
-    /// <author>  dswitkin@google.com (Daniel Switkin)\r
-    /// \r
-    /// </author>\r
-    public sealed class DecodeHintType\r
-    { \r
-          // No, we can't use an enum here. J2ME doesn't support it.\r
-          /**\r
-           * Unspecified, application-specific hint. Maps to an unspecified {@link Object}.\r
-           */\r
-          public static DecodeHintType OTHER = new DecodeHintType();\r
-\r
-          /**\r
-           * Image is a pure monochrome image of a barcode. Doesn't matter what it maps to;\r
-           * use {@link Boolean#TRUE}.\r
-           */\r
-          public static DecodeHintType PURE_BARCODE = new DecodeHintType();\r
-\r
-          /**\r
-           * Image is known to be of one of a few possible formats.\r
-           * Maps to a {@link java.util.Vector} of {@link BarcodeFormat}s.\r
-           */\r
-          public static DecodeHintType POSSIBLE_FORMATS = new DecodeHintType();\r
-\r
-          /**\r
-           * Spend more time to try to find a barcode; optimize for accuracy, not speed.\r
-           * Doesn't matter what it maps to; use {@link Boolean#TRUE}.\r
-           */\r
-          public static DecodeHintType TRY_HARDER = new DecodeHintType();\r
-\r
-          private DecodeHintType() {\r
-          }\r
-    \r
-    }\r
+       \r
+       /// <summary> Encapsulates a type of hint that a caller may pass to a barcode reader to help it\r
+       /// more quickly or accurately decode it. It is up to implementations to decide what,\r
+       /// if anything, to do with the information that is supplied.\r
+       /// \r
+       /// </summary>\r
+       /// <author>  Sean Owen\r
+       /// </author>\r
+       /// <author>  dswitkin@google.com (Daniel Switkin)\r
+       /// </author>\r
+       /// <author>www.Redivivus.in (suraj.supekar@redivivus.in) - Ported from ZXING Java Source \r
+       /// </author>\r
+       /// <seealso cref="Reader.decode(BinaryBitmap,java.util.Hashtable)">\r
+       /// </seealso>\r
+       public sealed class DecodeHintType\r
+       {\r
+               \r
+               // No, we can't use an enum here. J2ME doesn't support it.\r
+               \r
+               /// <summary> Unspecified, application-specific hint. Maps to an unspecified {@link Object}.</summary>\r
+               //UPGRADE_NOTE: Final was removed from the declaration of 'OTHER '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"\r
+               public static readonly DecodeHintType OTHER = new DecodeHintType();\r
+               \r
+               /// <summary> Image is a pure monochrome image of a barcode. Doesn't matter what it maps to;\r
+               /// use {@link Boolean#TRUE}.\r
+               /// </summary>\r
+               //UPGRADE_NOTE: Final was removed from the declaration of 'PURE_BARCODE '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"\r
+               public static readonly DecodeHintType PURE_BARCODE = new DecodeHintType();\r
+               \r
+               /// <summary> Image is known to be of one of a few possible formats.\r
+               /// Maps to a {@link java.util.Vector} of {@link BarcodeFormat}s.\r
+               /// </summary>\r
+               //UPGRADE_NOTE: Final was removed from the declaration of 'POSSIBLE_FORMATS '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"\r
+               public static readonly DecodeHintType POSSIBLE_FORMATS = new DecodeHintType();\r
+               \r
+               /// <summary> Spend more time to try to find a barcode; optimize for accuracy, not speed.\r
+               /// Doesn't matter what it maps to; use {@link Boolean#TRUE}.\r
+               /// </summary>\r
+               //UPGRADE_NOTE: Final was removed from the declaration of 'TRY_HARDER '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"\r
+               public static readonly DecodeHintType TRY_HARDER = new DecodeHintType();\r
+               \r
+               /// <summary> Allowed lengths of encoded data -- reject anything else. Maps to an int[].</summary>\r
+               //UPGRADE_NOTE: Final was removed from the declaration of 'ALLOWED_LENGTHS '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"\r
+               public static readonly DecodeHintType ALLOWED_LENGTHS = new DecodeHintType();\r
+               \r
+               /// <summary> Assume Code 39 codes employ a check digit. Maps to {@link Boolean}.</summary>\r
+               //UPGRADE_NOTE: Final was removed from the declaration of 'ASSUME_CODE_39_CHECK_DIGIT '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"\r
+               public static readonly DecodeHintType ASSUME_CODE_39_CHECK_DIGIT = new DecodeHintType();\r
+               \r
+               /// <summary> The caller needs to be notified via callback when a possible {@link ResultPoint}\r
+               /// is found. Maps to a {@link ResultPointCallback}.\r
+               /// </summary>\r
+               //UPGRADE_NOTE: Final was removed from the declaration of 'NEED_RESULT_POINT_CALLBACK '. "ms-help://MS.VSCC.v80/dv_commoner/local/redirect.htm?index='!DefaultContextWindowIndex'&keyword='jlca1003'"\r
+               public static readonly DecodeHintType NEED_RESULT_POINT_CALLBACK = new DecodeHintType();\r
+               \r
+               private DecodeHintType()\r
+               {\r
+               }\r
+       }\r
 }
\ No newline at end of file