User-contributed doc fixes and Issue 725

git-svn-id: https://zxing.googlecode.com/svn/trunk@1718 59b500cc-1b3d-0410-9834-0bbf25fbcc57
This commit is contained in:
srowen 2011-02-21 14:53:11 +00:00
parent 7a6cc4c3d0
commit ea813c3f88
2 changed files with 11 additions and 7 deletions

View file

@ -39,7 +39,7 @@ import android.net.Uri;
* <p>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:</p>
*
* <p>{@code
* <pre>{@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
* ...
* }
* }</p>
* }</pre>
*
* <p>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:</p>
*
* <p>{@code IntentIntegrator.initiateScan(yourActivity);}</p>
* <pre>{@code IntentIntegrator.initiateScan(yourActivity);}</pre>
*
* <p>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 {
* <p>Call this from your {@link Activity}'s
* {@link Activity#onActivityResult(int, int, Intent)} method.</p>
*
* @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.
*/

View file

@ -27,10 +27,14 @@ import com.google.zxing.common.BitArray;
import java.util.Hashtable;
/**
* <p>Implements decoding of the ITF format.</p>
* <p>Implements decoding of the ITF format, or Interleaved Two of Five.</p>
*
* <p>"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
* <p>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.</p>
*
* <p>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.</p>
*
* <p><a href="http://en.wikipedia.org/wiki/Interleaved_2_of_5">http://en.wikipedia.org/wiki/Interleaved_2_of_5</a>