From d3001ecc28b4b279c3b0bda2adf6cc5afb198727 Mon Sep 17 00:00:00 2001
From: Yuan Chiu <chyuaner@gmail.com>
Date: Mon, 4 Aug 2014 17:52:50 -0700
Subject: [PATCH] Fix All Comment

---
 htdocs/lib/Config/Exceptions.php    | 13 ++++++------
 htdocs/lib/Database/DBAdmin.php     |  9 ++++-----
 htdocs/lib/Database/DBUser.php      |  9 ++++-----
 htdocs/lib/Database/Database.php    |  8 ++++----
 htdocs/lib/Database/Exceptions.php  | 17 ++++++++--------
 htdocs/lib/Database/MySQLDB.php     |  5 +++--
 htdocs/lib/User/ClassGroup.php      |  7 +++++++
 htdocs/lib/User/ClassGroupAdmin.php |  7 +++++++
 htdocs/lib/User/Exceptions.php      | 31 +++++++++++++++++++++--------
 htdocs/lib/User/User.php            | 10 +++++-----
 htdocs/lib/User/UserControl.php     | 16 +++++++--------
 htdocs/lib/User/UserGroup.php       |  7 +++++++
 htdocs/lib/User/UserGroupAdmin.php  |  7 +++++++
 htdocs/lib/User/UserSession.php     |  4 ++--
 14 files changed, 95 insertions(+), 55 deletions(-)

diff --git a/htdocs/lib/Config/Exceptions.php b/htdocs/lib/Config/Exceptions.php
index 057302e..da28aee 100644
--- a/htdocs/lib/Config/Exceptions.php
+++ b/htdocs/lib/Config/Exceptions.php
@@ -1,11 +1,10 @@
-<?php namespace UElearning\Config\Exception;
+<?php
 /**
- * @file
- * 設定檔的例外
- * 
- * @package         UElearning
- * @subpackage      Config
+ * 設定檔的例外檔案
  */
 
-class ConfigNoFoundException extends \UnexpectedValueException {}
+namespace UElearning\Config\Exception;
+
+/*class ConfigNoFoundException extends \UnexpectedValueException {}
 class ConfigErrException extends \UnexpectedValueException {}
+*/
\ No newline at end of file
diff --git a/htdocs/lib/Database/DBAdmin.php b/htdocs/lib/Database/DBAdmin.php
index 8cfeb84..f604982 100644
--- a/htdocs/lib/Database/DBAdmin.php
+++ b/htdocs/lib/Database/DBAdmin.php
@@ -1,13 +1,12 @@
-<?php namespace UElearning\Database;
+<?php
 /**
- * @file
  * 整體資料庫操作
  *
  * 此檔案針對整體資料庫的功能，像是建立此資料庫、建立表格、清空...等等
- * 
- * @package         UElearning
- * @subpackage      Database
  */
+
+namespace UElearning\Database;
+
 require_once UELEARNING_LIB_ROOT.'Database/Database.php';
 require_once UELEARNING_LIB_ROOT.'Database/Exceptions.php';
 
diff --git a/htdocs/lib/Database/DBUser.php b/htdocs/lib/Database/DBUser.php
index 9875196..b239da5 100644
--- a/htdocs/lib/Database/DBUser.php
+++ b/htdocs/lib/Database/DBUser.php
@@ -1,13 +1,12 @@
-<?php namespace UElearning\Database;
+<?php
 /**
- * @file
  * 使用者資料表
  *
  * 此檔案針對使用者資料表的功能。
- * 
- * @package         UElearning
- * @subpackage      Database
  */
+
+namespace UElearning\Database;
+
 require_once UELEARNING_LIB_ROOT.'Database/Database.php';
 require_once UELEARNING_LIB_ROOT.'Database/Exceptions.php';
 
diff --git a/htdocs/lib/Database/Database.php b/htdocs/lib/Database/Database.php
index 54d2b96..a4729dd 100644
--- a/htdocs/lib/Database/Database.php
+++ b/htdocs/lib/Database/Database.php
@@ -1,13 +1,13 @@
-<?php namespace UElearning\Database;
+<?php 
 /**
- * @file
  * 整體資料庫操作
  *
  * 此檔案針對整體資料庫的功能，像是建立此資料庫、建立表格、清空...等等
  * 
- * @package         UElearning
- * @subpackage      Database
  */
+
+namespace UElearning\Database;
+
 require_once UELEARNING_LIB_ROOT.'Database/MySQLDB.php';
 require_once UELEARNING_LIB_ROOT.'Database/Exceptions.php';
 use UElearning\Database\Exception;
diff --git a/htdocs/lib/Database/Exceptions.php b/htdocs/lib/Database/Exceptions.php
index 1b370b0..3a7dcd0 100644
--- a/htdocs/lib/Database/Exceptions.php
+++ b/htdocs/lib/Database/Exceptions.php
@@ -1,20 +1,21 @@
-<?php namespace UElearning\Database\Exception;
+<?php
 /**
- * @file
- * 設定檔的例外
- * 
- * @package         UElearning
- * @subpackage      Database
- * 
+ * 資料庫相關的例外檔案
  */
 
+namespace UElearning\Database\Exception;
+
 /**
  * 沒有支援的資料庫系統例外
  * @since 3.0.0
  */ 
 class DatabaseNoSupportException extends \UnexpectedValueException {
-    private $type;
     
+    /**
+     * 欲使用的資料庫系統名稱
+     * @type string
+     */ 
+    private $type;
     
     /**
      * 沒有支援的資料庫系統
diff --git a/htdocs/lib/Database/MySQLDB.php b/htdocs/lib/Database/MySQLDB.php
index 8f6035d..5aaabd8 100644
--- a/htdocs/lib/Database/MySQLDB.php
+++ b/htdocs/lib/Database/MySQLDB.php
@@ -1,12 +1,13 @@
-<?php namespace UElearning\Database;
+<?php
 /**
- * @file
  * 資料庫連接專用
  *
  * 有用到的Define:
  * DB_NAME, DB_HOST, DB_USER, DB_PASS
  */
 
+namespace UElearning\Database;
+
 use \PDO;
 
 /**
diff --git a/htdocs/lib/User/ClassGroup.php b/htdocs/lib/User/ClassGroup.php
index e69de29..46830d9 100644
--- a/htdocs/lib/User/ClassGroup.php
+++ b/htdocs/lib/User/ClassGroup.php
@@ -0,0 +1,7 @@
+<?php 
+/**
+ * 使用者班級群組類別檔案
+ */
+
+namespace UElearning\User;
+// TODO: write this code
\ No newline at end of file
diff --git a/htdocs/lib/User/ClassGroupAdmin.php b/htdocs/lib/User/ClassGroupAdmin.php
index e69de29..2ba6220 100644
--- a/htdocs/lib/User/ClassGroupAdmin.php
+++ b/htdocs/lib/User/ClassGroupAdmin.php
@@ -0,0 +1,7 @@
+<?php 
+/**
+ * 班級群組管理類別檔案
+ */
+
+namespace UElearning\User;
+// TODO: write this code
\ No newline at end of file
diff --git a/htdocs/lib/User/Exceptions.php b/htdocs/lib/User/Exceptions.php
index 1b664d0..86f8472 100644
--- a/htdocs/lib/User/Exceptions.php
+++ b/htdocs/lib/User/Exceptions.php
@@ -1,16 +1,15 @@
-<?php namespace UElearning\User\Exception;
+<?php
 /**
- * @file
- * 設定檔的例外
- * 
- * @package         UElearning
- * @subpackage      User
- * 
+ * 使用者帳號群組相關例外類別檔案
  */
 
+namespace UElearning\User\Exception;
+
 /**
  * 使用者帳號例外
  * @since 3.0.0
+ * @package         UElearning
+ * @subpackage      User
  */ 
 abstract class UserException extends \UnexpectedValueException {
     
@@ -22,7 +21,7 @@ abstract class UserException extends \UnexpectedValueException {
     
     /**
      * 使用者帳號例外
-     * @param array $userId 輸入的使用者名稱
+     * @param string $userId 輸入的使用者名稱
      * @param string $description 描述
      */ 
     public function __construct($userId, $description) {
@@ -45,6 +44,10 @@ abstract class UserException extends \UnexpectedValueException {
  * @since 3.0.0
  */ 
 class UserNoFoundException extends UserException {
+    /**
+     * 沒有找到此帳號
+     * @param string $userId 輸入的使用者名稱
+     */ 
     public function __construct($userId) {
         parent::__construct($userId, 'User: "'.$this->type.'" is no found.');
     }
@@ -55,6 +58,10 @@ class UserNoFoundException extends UserException {
  * @since 3.0.0
  */ 
 class UserPasswordErrException extends UserException {
+    /**
+     * 沒有找到此帳號
+     * @param string $userId 輸入的使用者名稱
+     */ 
     public function __construct($userId) {
         parent::__construct($userId, 'User: "'.$this->type.'" password is wrong.');
     }
@@ -65,6 +72,10 @@ class UserPasswordErrException extends UserException {
  * @since 3.0.0
  */ 
 class UserNoActivatedException extends UserException {
+    /**
+     * 此帳號未啟用
+     * @param string $userId 輸入的使用者名稱
+     */ 
     public function __construct($userId) {
         parent::__construct($userId, 'User: "'.$this->type.'" is no activated.');
     }
@@ -76,6 +87,10 @@ class UserNoActivatedException extends UserException {
  * @since 3.0.0
  */ 
 class UserIdExistException extends UserException {
+    /**
+     * 已有重複的使用者名稱
+     * @param string $userId 輸入的使用者名稱
+     */ 
     public function __construct($userId) {
         parent::__construct($userId, 'UserId: "'.$this->type.'" is exist.');
     }
diff --git a/htdocs/lib/User/User.php b/htdocs/lib/User/User.php
index 08fa72b..78cb79a 100644
--- a/htdocs/lib/User/User.php
+++ b/htdocs/lib/User/User.php
@@ -1,8 +1,8 @@
-<?php namespace UElearning\User;
+<?php
 /**
- * @file
  * 此位使用者的相關操作
- *
- * @todo: ew
  */
-// @todo fdnskfjn
\ No newline at end of file
+
+namespace UElearning\User;
+
+// TODO: write this code
\ No newline at end of file
diff --git a/htdocs/lib/User/UserControl.php b/htdocs/lib/User/UserControl.php
index 48bdffa..0a07de5 100644
--- a/htdocs/lib/User/UserControl.php
+++ b/htdocs/lib/User/UserControl.php
@@ -1,17 +1,15 @@
-<?php namespace UElearning\User;
+<?php 
 /**
- * @file
  * 管理使用者的操作
- *
- * @package         UElearning
- * @subpackage      User
  */
 
+namespace UElearning\User;
+
 /**
- * 使用者帳號管理
+ * 管理使用者的操作
  * 
  * @author          Yuan Chiu <chyuaner@gmail.com>
- * @version         3.0
+ * @version         2.0.0
  * @package         UElearning
  * @subpackage      User
  */ 
@@ -19,7 +17,7 @@ class UserControl {
     
     /**
      * 建立使用者
-     * @since 3.0.0
+     * @since 2.0.0
      */ 
     public function create() {
        // TODO: Fill code in 
@@ -30,7 +28,7 @@ class UserControl {
      * 
      * @param string $userName 帳號名稱
      * @return bool 已有相同的帳號名稱
-     * @since 3.0.0
+     * @since 2.0.0
      */ 
     public function isExist($userName) {
         // TODO: Fill code in 
diff --git a/htdocs/lib/User/UserGroup.php b/htdocs/lib/User/UserGroup.php
index e69de29..857b05f 100644
--- a/htdocs/lib/User/UserGroup.php
+++ b/htdocs/lib/User/UserGroup.php
@@ -0,0 +1,7 @@
+<?php 
+/**
+ * 使用者群組類別檔案
+ */
+
+namespace UElearning\User;
+// TODO: write this code
\ No newline at end of file
diff --git a/htdocs/lib/User/UserGroupAdmin.php b/htdocs/lib/User/UserGroupAdmin.php
index e69de29..5a38ccc 100644
--- a/htdocs/lib/User/UserGroupAdmin.php
+++ b/htdocs/lib/User/UserGroupAdmin.php
@@ -0,0 +1,7 @@
+<?php 
+/**
+ * 使用者群組管理類別檔案
+ */
+
+namespace UElearning\User;
+// TODO: write this code
\ No newline at end of file
diff --git a/htdocs/lib/User/UserSession.php b/htdocs/lib/User/UserSession.php
index 9f39064..0f66d39 100644
--- a/htdocs/lib/User/UserSession.php
+++ b/htdocs/lib/User/UserSession.php
@@ -1,7 +1,7 @@
 <?php 
 /**
-* 使用者登入階段管理類別檔案
-*/
+ * 使用者登入階段管理類別檔案
+ */
 
 namespace UElearning\User;