-/*\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
* You may obtain a copy of the License at\r
* See the License for the specific language governing permissions and\r
* limitations under the License.\r
*/\r
-\r
using System;\r
-using System.Collections;\r
-\r
namespace com.google.zxing\r
{\r
- public interface Reader\r
- { \r
- /**\r
- * Locates and decodes a barcode in some format within an image.\r
- *\r
- * @param image image of barcode to decode\r
- * @return String which the barcode encodes\r
- * @throws ReaderException if the barcode cannot be located or decoded for any reason\r
- */\r
- Result decode(MonochromeBitmapSource image);\r
-\r
- /**\r
- * Locates and decodes a barcode in some format within an image. This method also accepts\r
- * hints, each possibly associated to some data, which may help the implementation decode.\r
- *\r
- * @param image image of barcode to decode\r
- * @param hints passed as a {@link Hashtable} from {@link DecodeHintType} to aribtrary data. The\r
- * meaning of the data depends upon the hint type. The implementation may or may not do\r
- * anything with these hints.\r
- * @return String which the barcode encodes\r
- * @throws ReaderException if the barcode cannot be located or decoded for any reason\r
- */\r
- Result decode(MonochromeBitmapSource image, Hashtable hints); \r
- }\r
+ \r
+ /// <summary> Implementations of this interface can decode an image of a barcode in some format into\r
+ /// the String it encodes. For example, {@link com.google.zxing.qrcode.QRCodeReader} can\r
+ /// decode a QR code. The decoder may optionally receive hints from the caller which may help\r
+ /// it decode more quickly or accurately.\r
+ /// \r
+ /// See {@link com.google.zxing.MultiFormatReader}, which attempts to determine what barcode\r
+ /// format is present within the image as well, and then decodes it accordingly.\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
\r
+ public interface Reader\r
+ {\r
+ \r
+ /// <summary> Locates and decodes a barcode in some format within an image.\r
+ /// \r
+ /// </summary>\r
+ /// <param name="image">image of barcode to decode\r
+ /// </param>\r
+ /// <returns> String which the barcode encodes\r
+ /// </returns>\r
+ /// <throws> ReaderException if the barcode cannot be located or decoded for any reason </throws>\r
+ Result decode(BinaryBitmap image);\r
+ \r
+ /// <summary> Locates and decodes a barcode in some format within an image. This method also accepts\r
+ /// hints, each possibly associated to some data, which may help the implementation decode.\r
+ /// \r
+ /// </summary>\r
+ /// <param name="image">image of barcode to decode\r
+ /// </param>\r
+ /// <param name="hints">passed as a {@link java.util.Hashtable} from {@link com.google.zxing.DecodeHintType}\r
+ /// to arbitrary data. The\r
+ /// meaning of the data depends upon the hint type. The implementation may or may not do\r
+ /// anything with these hints.\r
+ /// </param>\r
+ /// <returns> String which the barcode encodes\r
+ /// </returns>\r
+ /// <throws> ReaderException if the barcode cannot be located or decoded for any reason </throws>\r
+ Result decode(BinaryBitmap image, System.Collections.Hashtable hints);\r
+ }\r
}
\ No newline at end of file