Javadoc fixes

git-svn-id: https://zxing.googlecode.com/svn/trunk@2248 59b500cc-1b3d-0410-9834-0bbf25fbcc57

android/src/com/google/zxing/client/android/Intents.java

@@ -67,9 +67,7 @@ public final class Intents {
     /**
      * Comma-separated list of formats to scan for. The values must match the names of
      * {@link com.google.zxing.BarcodeFormat}s, e.g. {@link com.google.zxing.BarcodeFormat#EAN_13}.
-     * Example: "EAN_13,EAN_8,QR_CODE"
+     * Example: "EAN_13,EAN_8,QR_CODE". This overrides {@link #MODE}.
-     *
-     * This overrides {@link #MODE}.
      */
     public static final String FORMATS = "SCAN_FORMATS";
 
@@ -99,43 +97,46 @@ public final class Intents {
     public static final String PROMPT_MESSAGE = "PROMPT_MESSAGE";
 
     /**
-     * If a barcode is found, Barcodes returns RESULT_OK to 
+     * If a barcode is found, Barcodes returns {@link android.app.Activity#RESULT_OK} to
      * {@link android.app.Activity#onActivityResult(int, int, android.content.Intent)}
      * of the app which requested the scan via
      * {@link android.app.Activity#startActivityForResult(android.content.Intent, int)}
      * The barcodes contents can be retrieved with
      * {@link android.content.Intent#getStringExtra(String)}. 
-     * If the user presses Back, the result code will be
+     * If the user presses Back, the result code will be {@link android.app.Activity#RESULT_CANCELED}.
-     * RESULT_CANCELED.
      */
     public static final String RESULT = "SCAN_RESULT";
 
     /**
-     * Call intent.getStringExtra(RESULT_FORMAT) to determine which barcode format was found.
+     * Call {@link android.content.Intent#getStringExtra(String)} with {@link #RESULT_FORMAT}
-     * See Contents.Format for possible values.
+     * to determine which barcode format was found.
+     * See {@link com.google.zxing.BarcodeFormat} for possible values.
      */
     public static final String RESULT_FORMAT = "SCAN_RESULT_FORMAT";
 
     /**
-     * Call intent.getStringExtra(RESULT_UPC_EAN_EXTENSION) to return any scanned additional barcode
+     * Call {@link android.content.Intent#getStringExtra(String)} with {@link #RESULT_UPC_EAN_EXTENSION}
+     * to return the content of any UPC extension barcode that was also found. Only applicable
+     * to {@link com.google.zxing.BarcodeFormat#UPC_A} and {@link com.google.zxing.BarcodeFormat#EAN_13}
+     * formats.
      */
     public static final String RESULT_UPC_EAN_EXTENSION = "SCAN_RESULT_UPC_EAN_EXTENSION";
 
     /**
-     * Call intent.getByteArrayExtra(RESULT_BYTES) to get a {@code byte[]} of raw bytes in the
+     * Call {@link android.content.Intent#getByteArrayExtra(String)} with {@link #RESULT_BYTES}
-     * barcode, if available.
+     * to get a {@code byte[]} of raw bytes in the barcode, if available.
      */
     public static final String RESULT_BYTES = "SCAN_RESULT_BYTES";
 
     /**
      * Key for the value of {@link com.google.zxing.ResultMetadataType#ORIENTATION}, if available.
-     * Call intent.getIntExtra(RESULT_ORIENTATION).
+     * Call {@link android.content.Intent#getIntArrayExtra(String)} with {@link #RESULT_ORIENTATION}.
      */
     public static final String RESULT_ORIENTATION = "SCAN_RESULT_ORIENTATION";
 
     /**
      * Key for the value of {@link com.google.zxing.ResultMetadataType#ERROR_CORRECTION_LEVEL}, if available.
-     * Call intent.getStringExtra(RESULT_ERROR_CORRECTION_LEVEL).
+     * Call {@link android.content.Intent#getStringExtra(String)} with {@link #RESULT_ERROR_CORRECTION_LEVEL}.
      */
     public static final String RESULT_ERROR_CORRECTION_LEVEL = "SCAN_RESULT_ERROR_CORRECTION_LEVEL";
 
@@ -143,11 +144,12 @@ public final class Intents {
      * Prefix for keys that map to the values of {@link com.google.zxing.ResultMetadataType#BYTE_SEGMENTS},
      * if available. The actual values will be set under a series of keys formed by adding 0, 1, 2, ...
      * to this prefix. So the first byte segment is under key "SCAN_RESULT_BYTE_SEGMENTS_0" for example.
+     * Call {@link android.content.Intent#getByteArrayExtra(String)} with these keys.
      */
     public static final String RESULT_BYTE_SEGMENTS_PREFIX = "SCAN_RESULT_BYTE_SEGMENTS_";
 
     /**
-     * Setting this to false will not save scanned codes in the history.
+     * Setting this to false will not save scanned codes in the history. Specified as a {@code boolean}.
      */
     public static final String SAVE_HISTORY = "SAVE_HISTORY";
 

build.xml

@@ -52,10 +52,21 @@
   </target>
 
   <target name="javadoc">
+    <delete dir="docs/javadoc"/>
     <mkdir dir="docs/javadoc"/>
-    <javadoc destdir="docs/javadoc"
+    <javadoc failonerror="true"
-             useexternalfile="true"
+             destdir="docs/javadoc"
-             footer="&lt;script type=&quot;text/javascript&quot;&gt; var gaJsHost = ((&quot;https:&quot; == document.location.protocol) ?  &quot;https://ssl.&quot; : &quot;http://www.&quot;); document.write(unescape(&quot;%3Cscript src='&quot; + gaJsHost + &quot;google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E&quot;)); &lt;/script&gt; &lt;script type=&quot;text/javascript&quot;&gt; var pageTracker = _gat._getTracker(&quot;UA-788492-5&quot;); pageTracker._initData(); pageTracker._trackPageview(); &lt;/script&gt;">
+             footer="
+               &lt;script type=&quot;text/javascript&quot;&gt;;
+               var _gaq = _gaq || [];
+               _gaq.push(['_setAccount', 'UA-788492-5']);
+               _gaq.push(['_trackPageview']);
+               (function() {
+                 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+                 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+                 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+               })();
+               &lt;/script&gt;">
       <sourcepath>
         <pathelement location="android/src"/>
         <pathelement location="android/gen"/>