X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=csharp%2FReader.cs;h=c72e70a70972bc17de9ecbbaf6f11283b469b36f;hb=b67bb192563c0f16bbff8d02d6bf7aa3f949d9be;hp=631cab861c813b0a6c7d6ed6257a81278fbda25f;hpb=e35d358134873c3f640672da7cd0c01f02253151;p=zxing.git diff --git a/csharp/Reader.cs b/csharp/Reader.cs index 631cab86..c72e70a7 100755 --- a/csharp/Reader.cs +++ b/csharp/Reader.cs @@ -1,4 +1,6 @@ -/* +/* +* Copyright 2007 ZXing authors +* * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at @@ -11,35 +13,53 @@ * See the License for the specific language governing permissions and * limitations under the License. */ - using System; -using System.Collections; - namespace com.google.zxing { - public interface Reader - { - /** - * Locates and decodes a barcode in some format within an image. - * - * @param image image of barcode to decode - * @return String which the barcode encodes - * @throws ReaderException if the barcode cannot be located or decoded for any reason - */ - Result decode(MonochromeBitmapSource image); - - /** - * Locates and decodes a barcode in some format within an image. This method also accepts - * hints, each possibly associated to some data, which may help the implementation decode. - * - * @param image image of barcode to decode - * @param hints passed as a {@link Hashtable} from {@link DecodeHintType} to aribtrary data. The - * meaning of the data depends upon the hint type. The implementation may or may not do - * anything with these hints. - * @return String which the barcode encodes - * @throws ReaderException if the barcode cannot be located or decoded for any reason - */ - Result decode(MonochromeBitmapSource image, Hashtable hints); - } + + /// Implementations of this interface can decode an image of a barcode in some format into + /// the String it encodes. For example, {@link com.google.zxing.qrcode.QRCodeReader} can + /// decode a QR code. The decoder may optionally receive hints from the caller which may help + /// it decode more quickly or accurately. + /// + /// See {@link com.google.zxing.MultiFormatReader}, which attempts to determine what barcode + /// format is present within the image as well, and then decodes it accordingly. + /// + /// + /// Sean Owen + /// + /// dswitkin@google.com (Daniel Switkin) + /// + /// www.Redivivus.in (suraj.supekar@redivivus.in) - Ported from ZXING Java Source + /// + public interface Reader + { + + /// Locates and decodes a barcode in some format within an image. + /// + /// + /// image of barcode to decode + /// + /// String which the barcode encodes + /// + /// ReaderException if the barcode cannot be located or decoded for any reason + Result decode(BinaryBitmap image); + + /// Locates and decodes a barcode in some format within an image. This method also accepts + /// hints, each possibly associated to some data, which may help the implementation decode. + /// + /// + /// image of barcode to decode + /// + /// passed as a {@link java.util.Hashtable} from {@link com.google.zxing.DecodeHintType} + /// to arbitrary data. The + /// meaning of the data depends upon the hint type. The implementation may or may not do + /// anything with these hints. + /// + /// String which the barcode encodes + /// + /// ReaderException if the barcode cannot be located or decoded for any reason + Result decode(BinaryBitmap image, System.Collections.Hashtable hints); + } } \ No newline at end of file