添加了remote包和 note包的方法注释

app/src/main/java/net/micode/notes/gtask/remote/GTaskASyncTask.java

@@ -99,6 +99,10 @@ public class GTaskASyncTask extends AsyncTask<Void, String, Integer> {
 
     @Override
     protected Integer doInBackground(Void... unused) {
+        /**
+         *  执行GTask同步操作
+         *  @return 同步结果
+         */
         publishProgess(mContext.getString(R.string.sync_progress_login, NotesPreferenceActivity
                 .getSyncAccountName(mContext)));
         return mTaskManager.sync(mContext, this);
@@ -106,29 +110,50 @@ public class GTaskASyncTask extends AsyncTask<Void, String, Integer> {
 
     @Override
     protected void onProgressUpdate(String... progress) {
+        /**
+         *  显示同步进度通知
+         */
         showNotification(R.string.ticker_syncing, progress[0]);
         if (mContext instanceof GTaskSyncService) {
+            /**
+             *   发送广播更新同步进度
+             */
             ((GTaskSyncService) mContext).sendBroadcast(progress[0]);
         }
     }
 
     @Override
     protected void onPostExecute(Integer result) {
+        /**
+         *   同步成功
+         */
         if (result == GTaskManager.STATE_SUCCESS) {
             showNotification(R.string.ticker_success, mContext.getString(
                     R.string.success_sync_account, mTaskManager.getSyncAccount()));
             NotesPreferenceActivity.setLastSyncTime(mContext, System.currentTimeMillis());
+            /**
+             *   网络异常
+             */
         } else if (result == GTaskManager.STATE_NETWORK_ERROR) {
             showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_network));
+            /**
+             *   内部错误
+             */
         } else if (result == GTaskManager.STATE_INTERNAL_ERROR) {
             showNotification(R.string.ticker_fail, mContext.getString(R.string.error_sync_internal));
+            /**
+             *   同步被取消
+             */
         } else if (result == GTaskManager.STATE_SYNC_CANCELLED) {
             showNotification(R.string.ticker_cancel, mContext
                     .getString(R.string.error_sync_cancelled));
         }
+
         if (mOnCompleteListener != null) {
             new Thread(new Runnable() {
-
+                /**
+                 *  调用完成监听器
+                 */
                 public void run() {
                     mOnCompleteListener.onComplete();
                 }

app/src/main/java/net/micode/notes/gtask/remote/GTaskClient.java

@@ -108,7 +108,11 @@ public class GTaskClient {
         }
         return mInstance;
     }
-
+    /**
+     * 登录
+     * @param activity Activity
+     * @return 登录是否成功
+     */
     public boolean login(Activity activity) {
         // we suppose that the cookie would expire after 5 minutes
         // then we need to re-login
@@ -163,7 +167,12 @@ public class GTaskClient {
         mLoggedin = true;
         return true;
     }
-
+    /**
+     * 使用Google账户登录
+     * @param activity Activity
+     * @param invalidateToken 是否使验证令牌过期
+     * @return 验证令牌
+     */
     private String loginGoogleAccount(Activity activity, boolean invalidateToken) {
         String authToken;
         AccountManager accountManager = AccountManager.get(activity);
@@ -206,7 +215,12 @@ public class GTaskClient {
 
         return authToken;
     }
-
+    /**
+     * 尝试登陆Gtask
+     * @param activity Activity
+     * @param authToken 验证令牌
+     * @return 登录是否成功
+     */
     private boolean tryToLoginGtask(Activity activity, String authToken) {
         if (!loginGtask(authToken)) {
             // maybe the auth token is out of date, now let's invalidate the
@@ -224,7 +238,11 @@ public class GTaskClient {
         }
         return true;
     }
-
+    /**
+     * 登录Gtask
+     * @param authToken 验证令牌
+     * @return 登录是否成功
+     */
     private boolean loginGtask(String authToken) {
         int timeoutConnection = 10000;
         int timeoutSocket = 15000;
@@ -279,18 +297,29 @@ public class GTaskClient {
 
         return true;
     }
-
+    /**
+     * 获取动作ID
+     * @return 动作ID
+     */
     private int getActionId() {
         return mActionId++;
     }
-
+    /**
+     * 创建HTTP POST请求
+     * @return HTTP POST请求
+     */
     private HttpPost createHttpPost() {
         HttpPost httpPost = new HttpPost(mPostUrl);
         httpPost.setHeader("Content-Type", "application/x-www-form-urlencoded;charset=utf-8");
         httpPost.setHeader("AT", "1");
         return httpPost;
     }
-
+    /**
+     * 获取响应内容
+     * @param entity HttpEntity
+     * @return 响应内容
+     * @throws IOException
+     */
     private String getResponseContent(HttpEntity entity) throws IOException {
         String contentEncoding = null;
         if (entity.getContentEncoding() != null) {
@@ -322,7 +351,13 @@ public class GTaskClient {
             input.close();
         }
     }
-
+    /**
+     * 发出POST请求
+     * @param js JSON对象
+     * @return 响应JSON对象
+     * @throws NetworkFailureException
+     * @throws ActionFailureException
+     */
     private JSONObject postRequest(JSONObject js) throws NetworkFailureException {
         if (!mLoggedin) {
             Log.e(TAG, "please login first");
@@ -359,7 +394,11 @@ public class GTaskClient {
             throw new ActionFailureException("error occurs when posting request");
         }
     }
-
+    /**
+     * 创建任务
+     * @param task 任务
+     * @throws NetworkFailureException
+     */
     public void createTask(Task task) throws NetworkFailureException {
         commitUpdate();
         try {
@@ -385,7 +424,11 @@ public class GTaskClient {
             throw new ActionFailureException("create task: handing jsonobject failed");
         }
     }
-
+    /**
+     * 创建任务列表
+     * @param tasklist 任务列表
+     * @throws NetworkFailureException
+     */
     public void createTaskList(TaskList tasklist) throws NetworkFailureException {
         commitUpdate();
         try {
@@ -411,7 +454,10 @@ public class GTaskClient {
             throw new ActionFailureException("create tasklist: handing jsonobject failed");
         }
     }
-
+    /**
+     * 提交更新
+     * @throws NetworkFailureException
+     */
     public void commitUpdate() throws NetworkFailureException {
         if (mUpdateArray != null) {
             try {
@@ -432,7 +478,11 @@ public class GTaskClient {
             }
         }
     }
-
+    /**
+     * 添加更新节点
+     * @param node 节点
+     * @throws NetworkFailureException
+     */
     public void addUpdateNode(Node node) throws NetworkFailureException {
         if (node != null) {
             // too many update items may result in an error
@@ -446,7 +496,13 @@ public class GTaskClient {
             mUpdateArray.put(node.getUpdateAction(getActionId()));
         }
     }
-
+    /**
+     * 移动任务
+     * @param task 任务
+     * @param preParent 上一个父任务列表
+     * @param curParent 当前父任务列表
+     * @throws NetworkFailureException
+     */
     public void moveTask(Task task, TaskList preParent, TaskList curParent)
             throws NetworkFailureException {
         commitUpdate();
@@ -485,7 +541,11 @@ public class GTaskClient {
             throw new ActionFailureException("move task: handing jsonobject failed");
         }
     }
-
+    /**
+     * 删除节点
+     * @param node 节点
+     * @throws NetworkFailureException
+     */
     public void deleteNode(Node node) throws NetworkFailureException {
         commitUpdate();
         try {
@@ -508,7 +568,12 @@ public class GTaskClient {
             throw new ActionFailureException("delete node: handing jsonobject failed");
         }
     }
-
+    /**
+     * 获取任务列表
+     * @return JSON数组格式的任务列表
+     * @throws NetworkFailureException
+     * @throws ActionFailureException
+     */
     public JSONArray getTaskLists() throws NetworkFailureException {
         if (!mLoggedin) {
             Log.e(TAG, "please login first");
@@ -546,7 +611,13 @@ public class GTaskClient {
             throw new ActionFailureException("get task lists: handing jasonobject failed");
         }
     }
-
+    /**
+     * 获取任务列表
+     * @param listGid 任务列表ID
+     * @return JSON数组格式的任务列表
+     * @throws NetworkFailureException
+     * @throws ActionFailureException
+     */
     public JSONArray getTaskList(String listGid) throws NetworkFailureException {
         commitUpdate();
         try {

app/src/main/java/net/micode/notes/gtask/remote/GTaskManager.java

@@ -167,7 +167,11 @@ public class GTaskManager {
 
         return mCancelled ? STATE_SYNC_CANCELLED : STATE_SUCCESS;
     }
-
+    /**
+     * 初始化GTask任务列表
+     * @throws NetworkFailureException
+     * @throws ActionFailureException
+     */
     private void initGTaskList() throws NetworkFailureException {
         if (mCancelled)
             return;
@@ -246,7 +250,10 @@ public class GTaskManager {
             throw new ActionFailureException("initGTaskList: handing JSONObject failed");
         }
     }
-
+    /**
+     * 同步内容
+     * @throws NetworkFailureException
+     */
     private void syncContent() throws NetworkFailureException {
         int syncType;
         Cursor c = null;
@@ -350,7 +357,10 @@ public class GTaskManager {
         }
 
     }
-
+    /**
+     * 同步文件夹
+     * @throws NetworkFailureException
+     */
     private void syncFolder() throws NetworkFailureException {
         Cursor c = null;
         String gid;
@@ -475,7 +485,13 @@ public class GTaskManager {
         if (!mCancelled)
             GTaskClient.getInstance().commitUpdate();
     }
-
+    /**
+     * 根据同步类型执行内容同步
+     * @param syncType 同步类型
+     * @param node 节点
+     * @param c 游标
+     * @throws NetworkFailureException
+     */
     private void doContentSync(int syncType, Node node, Cursor c) throws NetworkFailureException {
         if (mCancelled) {
             return;
@@ -521,7 +537,11 @@ public class GTaskManager {
                 throw new ActionFailureException("unkown sync action type");
         }
     }
-
+    /**
+     * 添加本地节点
+     * @param node 节点
+     * @throws NetworkFailureException
+     */
     private void addLocalNode(Node node) throws NetworkFailureException {
         if (mCancelled) {
             return;
@@ -595,7 +615,12 @@ public class GTaskManager {
         // update meta
         updateRemoteMeta(node.getGid(), sqlNote);
     }
-
+    /**
+     * 更新本地节点
+     * @param node 节点
+     * @param c 游标
+     * @throws NetworkFailureException
+     */
     private void updateLocalNode(Node node, Cursor c) throws NetworkFailureException {
         if (mCancelled) {
             return;
@@ -618,7 +643,12 @@ public class GTaskManager {
         // update meta info
         updateRemoteMeta(node.getGid(), sqlNote);
     }
-
+    /**
+     * 添加远程节点
+     * @param node 节点
+     * @param c 游标
+     * @throws NetworkFailureException
+     */
     private void addRemoteNode(Node node, Cursor c) throws NetworkFailureException {
         if (mCancelled) {
             return;
@@ -691,7 +721,12 @@ public class GTaskManager {
         mGidToNid.put(n.getGid(), sqlNote.getId());
         mNidToGid.put(sqlNote.getId(), n.getGid());
     }
-
+    /**
+     * 更新远程节点
+     * @param node 节点
+     * @param c 游标
+     * @throws NetworkFailureException
+     */
     private void updateRemoteNode(Node node, Cursor c) throws NetworkFailureException {
         if (mCancelled) {
             return;
@@ -729,7 +764,12 @@ public class GTaskManager {
         sqlNote.resetLocalModified();
         sqlNote.commit(true);
     }
-
+    /**
+     * 更新远程元数据
+     * @param gid GID
+     * @param sqlNote 笔记SqlNote
+     * @throws NetworkFailureException
+     */
     private void updateRemoteMeta(String gid, SqlNote sqlNote) throws NetworkFailureException {
         if (sqlNote != null && sqlNote.isNoteType()) {
             MetaData metaData = mMetaHashMap.get(gid);
@@ -746,6 +786,10 @@ public class GTaskManager {
         }
     }
 
+    /**
+     * 刷新本地同步ID
+     * @throws NetworkFailureException
+     */
     private void refreshLocalSyncId() throws NetworkFailureException {
         if (mCancelled) {
             return;

app/src/main/java/net/micode/notes/gtask/remote/GTaskSyncService.java

@@ -66,7 +66,13 @@ public class GTaskSyncService extends Service {
     public void onCreate() {
         mSyncTask = null;
     }
-
+    /**
+     * 服务启动时调用
+     * @param intent 意图
+     * @param flags 标志
+     * @param startId 启动ID
+     * @return START_STICKY
+     */
     @Override
     public int onStartCommand(Intent intent, int flags, int startId) {
         Bundle bundle = intent.getExtras();
@@ -85,18 +91,27 @@ public class GTaskSyncService extends Service {
         }
         return super.onStartCommand(intent, flags, startId);
     }
-
+    /**
+     * 服务内存低时调用
+     */
     @Override
     public void onLowMemory() {
         if (mSyncTask != null) {
             mSyncTask.cancelSync();
         }
     }
-
+    /**
+     * 绑定服务时调用
+     * @param intent 意图
+     * @return null
+     */
     public IBinder onBind(Intent intent) {
         return null;
     }
-
+    /**
+     * 发送广播
+     * @param msg 消息
+     */
     public void sendBroadcast(String msg) {
         mSyncProgress = msg;
         Intent intent = new Intent(GTASK_SERVICE_BROADCAST_NAME);
@@ -105,13 +120,20 @@ public class GTaskSyncService extends Service {
         sendBroadcast(intent);
     }
 
+    /**
+     * 开始同步
+     * @param activity activity
+     */
     public static void startSync(Activity activity) {
         GTaskManager.getInstance().setActivityContext(activity);
         Intent intent = new Intent(activity, GTaskSyncService.class);
         intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_START_SYNC);
         activity.startService(intent);
     }
-
+    /**
+     * 取消同步
+     * @param context 上下文
+     */
     public static void cancelSync(Context context) {
         Intent intent = new Intent(context, GTaskSyncService.class);
         intent.putExtra(GTaskSyncService.ACTION_STRING_NAME, GTaskSyncService.ACTION_CANCEL_SYNC);

app/src/main/java/net/micode/notes/model/WorkingNote.java

@@ -174,6 +174,15 @@ public class WorkingNote {
         }
     }
 
+    /**
+     * 创建空白便笺
+     * @param context 上下文
+     * @param folderId 文件夹ID
+     * @param widgetId 小组件ID
+     * @param widgetType 小组件类型
+     * @param defaultBgColorId 默认背景色ID
+     * @return WorkingNote
+     */
     public static WorkingNote createEmptyNote(Context context, long folderId, int widgetId,
             int widgetType, int defaultBgColorId) {
         WorkingNote note = new WorkingNote(context, folderId);
@@ -182,11 +191,19 @@ public class WorkingNote {
         note.setWidgetType(widgetType);
         return note;
     }
-
+    /**
+     * 加载便笺
+     * @param context 上下文
+     * @param id ID
+     * @return WorkingNote
+     */
     public static WorkingNote load(Context context, long id) {
         return new WorkingNote(context, id, 0);
     }
-
+    /**
+     * 保存便笺
+     * @return 是否保存成功
+     */
     public synchronized boolean saveNote() {
         if (isWorthSaving()) {
             if (!existInDatabase()) {
@@ -211,11 +228,17 @@ public class WorkingNote {
             return false;
         }
     }
-
+    /**
+     * 判断便笺是否存在于数据库
+     * @return 是否存在
+     */
     public boolean existInDatabase() {
         return mNoteId > 0;
     }
-
+    /**
+     * 判断便笺是否值得保存
+     * @return 是否值得保存
+     */
     private boolean isWorthSaving() {
         if (mIsDeleted || (!existInDatabase() && TextUtils.isEmpty(mContent))
                 || (existInDatabase() && !mNote.isLocalModified())) {
@@ -224,11 +247,18 @@ public class WorkingNote {
             return true;
         }
     }
-
+    /**
+     * 设置设置状态改变监听器
+     * @param l 监听器
+     */
     public void setOnSettingStatusChangedListener(NoteSettingChangedListener l) {
         mNoteSettingStatusListener = l;
     }
-
+    /**
+     * 设置警报日期
+     * @param date 日期
+     * @param set 是否设置
+     */
     public void setAlertDate(long date, boolean set) {
         if (date != mAlertDate) {
             mAlertDate = date;
@@ -238,7 +268,10 @@ public class WorkingNote {
             mNoteSettingStatusListener.onClockAlertChanged(date, set);
         }
     }
-
+    /**
+     * 标记删除
+     * @param mark 是否标记
+     */
     public void markDeleted(boolean mark) {
         mIsDeleted = mark;
         if (mWidgetId != AppWidgetManager.INVALID_APPWIDGET_ID
@@ -246,7 +279,10 @@ public class WorkingNote {
                 mNoteSettingStatusListener.onWidgetChanged();
         }
     }
-
+    /**
+     * 设置背景色ID
+     * @param id ID
+     */
     public void setBgColorId(int id) {
         if (id != mBgColorId) {
             mBgColorId = id;
@@ -256,7 +292,10 @@ public class WorkingNote {
             mNote.setNoteValue(NoteColumns.BG_COLOR_ID, String.valueOf(id));
         }
     }
-
+    /**
+     * 设置清单模式
+     * @param mode 模式
+     */
     public void setCheckListMode(int mode) {
         if (mMode != mode) {
             if (mNoteSettingStatusListener != null) {
@@ -266,21 +305,30 @@ public class WorkingNote {
             mNote.setTextData(TextNote.MODE, String.valueOf(mMode));
         }
     }
-
+    /**
+     * 设置小组件类型
+     * @param type 类型
+     */
     public void setWidgetType(int type) {
         if (type != mWidgetType) {
             mWidgetType = type;
             mNote.setNoteValue(NoteColumns.WIDGET_TYPE, String.valueOf(mWidgetType));
         }
     }
-
+    /**
+     * 设置小组件ID
+     * @param id ID
+     */
     public void setWidgetId(int id) {
         if (id != mWidgetId) {
             mWidgetId = id;
             mNote.setNoteValue(NoteColumns.WIDGET_ID, String.valueOf(mWidgetId));
         }
     }
-
+    /**
+     * 设置工作文本
+     * @param text 文本
+     */
     public void setWorkingText(String text) {
         if (!TextUtils.equals(mContent, text)) {
             mContent = text;