You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cordova.apache.org by ag...@apache.org on 2015/03/11 16:35:16 UTC

[05/13] cordova-plugin-file git commit: android: Delete invalid JavaDoc (lint errors)

android: Delete invalid JavaDoc (lint errors)


Project: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/repo
Commit: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/commit/c35d9135
Tree: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/tree/c35d9135
Diff: http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/diff/c35d9135

Branch: refs/heads/master
Commit: c35d9135b14c16410ba452a9a46fa6dfb8c832fb
Parents: 80f37d6
Author: Andrew Grieve <ag...@chromium.org>
Authored: Mon Mar 9 13:17:39 2015 -0400
Committer: Andrew Grieve <ag...@chromium.org>
Committed: Wed Mar 11 11:35:07 2015 -0400

----------------------------------------------------------------------
 src/android/FileUtils.java | 29 +----------------------------
 1 file changed, 1 insertion(+), 28 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cordova-plugin-file/blob/c35d9135/src/android/FileUtils.java
----------------------------------------------------------------------
diff --git a/src/android/FileUtils.java b/src/android/FileUtils.java
index 676d297..cd6f9c1 100644
--- a/src/android/FileUtils.java
+++ b/src/android/FileUtils.java
@@ -65,7 +65,7 @@ public class FileUtils extends CordovaPlugin {
     public static int QUOTA_EXCEEDED_ERR = 10;
     public static int TYPE_MISMATCH_ERR = 11;
     public static int PATH_EXISTS_ERR = 12;
-    
+
     public static int UNKNOWN_ERR = 1000;
     
     private boolean configured = false;
@@ -638,7 +638,6 @@ public class FileUtils extends CordovaPlugin {
     /**
      * Read the list of files from this directory.
      *
-     * @param fileName the directory to read from
      * @return a JSONArray containing JSONObjects that represent Entry objects.
      * @throws FileNotFoundException if the directory is not found.
      * @throws JSONException
@@ -661,8 +660,6 @@ public class FileUtils extends CordovaPlugin {
     /**
      * A setup method that handles the move/copy of files/directories
      *
-     * @param fileName to be copied/moved
-     * @param newParent is the location where the file will be copied/moved to
      * @param newName for the file directory to be called, if null use existing file name
      * @param move if false do a copy, if true do a move
      * @return a Entry object
@@ -699,7 +696,6 @@ public class FileUtils extends CordovaPlugin {
      * some of the contents of the directory may be deleted.
      * It is an error to attempt to delete the root directory of a filesystem.
      *
-     * @param filePath the directory to be removed
      * @return a boolean representing success of failure
      * @throws FileExistsException
      * @throws NoModificationAllowedException 
@@ -729,7 +725,6 @@ public class FileUtils extends CordovaPlugin {
      * Deletes a file or directory. It is an error to attempt to delete a directory that is not empty.
      * It is an error to attempt to delete the root directory of a filesystem.
      *
-     * @param filePath file or directory to be removed
      * @return a boolean representing success of failure
      * @throws NoModificationAllowedException
      * @throws InvalidModificationException
@@ -787,11 +782,6 @@ public class FileUtils extends CordovaPlugin {
     /**
      * Look up the parent DirectoryEntry containing this Entry.
      * If this Entry is the root of its filesystem, its parent is itself.
-     *
-     * @param filePath
-     * @return
-     * @throws JSONException
-     * @throws IOException 
      */
     private JSONObject getParent(String baseURLstr) throws JSONException, IOException {
         try {
@@ -810,11 +800,7 @@ public class FileUtils extends CordovaPlugin {
     /**
      * Returns a File that represents the current state of the file that this FileEntry represents.
      *
-     * @param filePath to entry
      * @return returns a JSONObject represent a W3C File object
-     * @throws FileNotFoundException
-     * @throws JSONException
-     * @throws MalformedURLException 
      */
     private JSONObject getFileMetadata(String baseURLstr) throws FileNotFoundException, JSONException, MalformedURLException {
         try {
@@ -858,10 +844,7 @@ public class FileUtils extends CordovaPlugin {
     /**
      * Requests a filesystem in which to store application data.
      *
-     * @param type of file system requested
      * @return a JSONObject representing the file system
-     * @throws IOException
-     * @throws JSONException
      */
     private JSONArray requestAllFileSystems() throws IOException, JSONException {
         JSONArray ret = new JSONArray();
@@ -939,14 +922,12 @@ public class FileUtils extends CordovaPlugin {
      * Read the contents of a file.
      * This is done in a background thread; the result is sent to the callback.
      *
-     * @param filename          The name of the file.
      * @param start             Start position in the file.
      * @param end               End position to stop at (exclusive).
      * @param callbackContext   The context through which to send the result.
      * @param encoding          The encoding to return contents as.  Typical value is UTF-8. (see http://www.iana.org/assignments/character-sets)
      * @param resultType        The desired type of data to send to the callback.
      * @return                  Contents of file.
-     * @throws MalformedURLException 
      */
     public void readFileAs(final String srcURLstr, final int start, final int end, final CallbackContext callbackContext, final String encoding, final int resultType) throws MalformedURLException {
         try {
@@ -1012,12 +993,9 @@ public class FileUtils extends CordovaPlugin {
     /**
      * Write contents of file.
      *
-     * @param filename			The name of the file.
      * @param data				The contents of the file.
      * @param offset			The position to begin writing the file.
      * @param isBinary          True if the file contents are base64-encoded binary data
-     * @throws FileNotFoundException, IOException
-     * @throws NoModificationAllowedException
      */
     /**/
     public long write(String srcURLstr, String data, int offset, boolean isBinary) throws FileNotFoundException, IOException, NoModificationAllowedException {
@@ -1037,11 +1015,6 @@ public class FileUtils extends CordovaPlugin {
 
     /**
      * Truncate the file to size
-     *
-     * @param filename
-     * @param size
-     * @throws FileNotFoundException, IOException
-     * @throws NoModificationAllowedException
      */
     private long truncateFile(String srcURLstr, long size) throws FileNotFoundException, IOException, NoModificationAllowedException {
         try {


---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@cordova.apache.org
For additional commands, e-mail: commits-help@cordova.apache.org