瀏覽代碼

added javadoc

AndyScherzinger 8 年之前
父節點
當前提交
66c4a57ba4

+ 7 - 0
src/com/owncloud/android/datamodel/MediaFolder.java

@@ -27,8 +27,15 @@ import java.util.List;
  * Business object representing a media folder with all information that are gathered via media queries.
  */
 public class MediaFolder {
+    /** name of the folder. */
     public String folderName;
+
+    /** absolute path of the folder. */
     public String absolutePath;
+    
+    /** list of file paths of the folder's content */
     public List<String> filePaths = new ArrayList<>();
+
+    /** total number of files in the media folder. */
     public long numberOfFiles;
 }

+ 28 - 0
src/com/owncloud/android/datamodel/SyncedFolder.java

@@ -21,6 +21,9 @@
 
 package com.owncloud.android.datamodel;
 
+/**
+ * Synced folder entity containing all information per synced folder.
+ */
 public class SyncedFolder {
     public static final long UNPERSISTED_ID = Long.MIN_VALUE;
     private long id = UNPERSISTED_ID;
@@ -33,6 +36,19 @@ public class SyncedFolder {
     private Integer uploadAction;
     private boolean enabled;
 
+    /**
+     * constructor for already persisted entity.
+     *
+     * @param id              the primary key
+     * @param localPath       local path
+     * @param remotePath      remote path
+     * @param wifiOnly        upload on wifi only flag
+     * @param chargingOnly    upload on charging only
+     * @param subfolderByDate create sub-folders by date (month)
+     * @param account         the account owning the synced folder
+     * @param uploadAction    the action to be done after the upload
+     * @param enabled         flag if synced folder config is active
+     */
     public SyncedFolder(long id, String localPath, String remotePath, Boolean wifiOnly, Boolean chargingOnly,
                         Boolean subfolderByDate, String account, Integer uploadAction, Boolean enabled) {
         this.id = id;
@@ -46,6 +62,18 @@ public class SyncedFolder {
         this.enabled = enabled;
     }
 
+    /**
+     * constructor for new, to be persisted entity.
+     *
+     * @param localPath       local path
+     * @param remotePath      remote path
+     * @param wifiOnly        upload on wifi only flag
+     * @param chargingOnly    upload on charging only
+     * @param subfolderByDate create sub-folders by date (month)
+     * @param account         the account owning the synced folder
+     * @param uploadAction    the action to be done after the upload
+     * @param enabled         flag if synced folder config is active
+     */
     public SyncedFolder(String localPath, String remotePath, Boolean wifiOnly, Boolean chargingOnly,
                         Boolean subfolderByDate, String account, Integer uploadAction, Boolean enabled) {
         this.localPath = localPath;

+ 1 - 1
src/com/owncloud/android/datamodel/SyncedFolderProvider.java

@@ -34,7 +34,7 @@ import java.util.List;
 import java.util.Observable;
 
 /**
- * Database provider for handling the persistence aspects of synced folders.
+ * Database provider for handling the persistence aspects of {@link SyncedFolder}s.
  */
 public class SyncedFolderProvider extends Observable {
     static private final String TAG = SyncedFolderProvider.class.getSimpleName();