From ea813c3f88949a6d3da68a672d8f14efc078c17b Mon Sep 17 00:00:00 2001 From: srowen Date: Mon, 21 Feb 2011 14:53:11 +0000 Subject: [PATCH] User-contributed doc fixes and Issue 725 git-svn-id: https://zxing.googlecode.com/svn/trunk@1718 59b500cc-1b3d-0410-9834-0bbf25fbcc57 --- .../zxing/integration/android/IntentIntegrator.java | 8 ++++---- core/src/com/google/zxing/oned/ITFReader.java | 10 +++++++--- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/android-integration/src/com/google/zxing/integration/android/IntentIntegrator.java b/android-integration/src/com/google/zxing/integration/android/IntentIntegrator.java index 019c666e0..105511bf4 100644 --- a/android-integration/src/com/google/zxing/integration/android/IntentIntegrator.java +++ b/android-integration/src/com/google/zxing/integration/android/IntentIntegrator.java @@ -39,7 +39,7 @@ import android.net.Uri; *

There are a few steps to using this integration. First, your {@link Activity} must implement * the method {@link Activity#onActivityResult(int, int, Intent)} and include a line of code like this:

* - *

{@code + * 

{@code
  * public void onActivityResult(int requestCode, int resultCode, Intent intent) {
  *   IntentResult scanResult = IntentIntegrator.parseActivityResult(requestCode, resultCode, intent);
  *   if (scanResult != null) {
@@ -48,12 +48,12 @@ import android.net.Uri;
  *   // else continue with any other code you need in the method
  *   ...
  * }
- * }

+ * }
* *

This is where you will handle a scan result. * Second, just call this in response to a user action somewhere to begin the scan process:

* - *

{@code IntentIntegrator.initiateScan(yourActivity);}

+ * 
{@code IntentIntegrator.initiateScan(yourActivity);}
* *

You can use {@link #initiateScan(Activity, CharSequence, CharSequence, CharSequence, CharSequence)} or * {@link #initiateScan(Activity, int, int, int, int)} to customize the download prompt with @@ -213,7 +213,7 @@ public final class IntentIntegrator { *

Call this from your {@link Activity}'s * {@link Activity#onActivityResult(int, int, Intent)} method.

* - * @return null if the event handled here was not related to {@link IntentIntegrator}, or + * @return null if the event handled here was not related to this class, or * else an {@link IntentResult} containing the result of the scan. If the user cancelled scanning, * the fields will be null. */ diff --git a/core/src/com/google/zxing/oned/ITFReader.java b/core/src/com/google/zxing/oned/ITFReader.java index be7f5eb85..54bbf5aca 100644 --- a/core/src/com/google/zxing/oned/ITFReader.java +++ b/core/src/com/google/zxing/oned/ITFReader.java @@ -27,10 +27,14 @@ import com.google.zxing.common.BitArray; import java.util.Hashtable; /** - *

Implements decoding of the ITF format.

+ *

Implements decoding of the ITF format, or Interleaved Two of Five.

* - *

"ITF" stands for Interleaved Two of Five. This Reader will scan ITF barcode with 6, 10 or 14 - * digits. The checksum is optional and is not applied by this Reader. The consumer of the decoded + *

This Reader will scan ITF barcodes of certain lengths only. + * At the moment it reads length 6, 10, 12, 14, 16, 24, and 44 as these have appeared "in the wild". Not all + * lengths are scanned, especially shorter ones, to avoid false positives. This in turn is due to a lack of + * required checksum function.

+ * + *

The checksum is optional and is not applied by this Reader. The consumer of the decoded * value will have to apply a checksum if required.

* *

http://en.wikipedia.org/wiki/Interleaved_2_of_5