add phpDoc comment in comment module

git-svn-id: http://xe-core.googlecode.com/svn/branches/1.5.0@10783 201d5d3c-b55e-5fd7-737f-ddc643e51545

modules/comment/comment.admin.controller.php

@@ -1,21 +1,24 @@
 <?php
-    /**
-     * @class  commentAdminController
-     * @author NHN (developers@xpressengine.com)
-     * @brief admin controller class of the comment module
-     **/
-
+	/**
+	 * commentAdminController class
+	 * admin controller class of the comment module
+	 *
+	 * @author NHN (developers@xpressengine.com)
+	 * @package /modules/comment
+	 * @version 0.1
+	 */
     class commentAdminController extends comment {
 
-        /**
-         * @brief Initialization
-         **/
+		/**
+		 * Initialization
+		 * @return void
+		 */
         function init() {
         }
 		
 	/**
-	* @brief Modify comment(s) status to publish/unpublish if calling module is using Comment Approval System
-	* @return Object 
+	* Modify comment(s) status to publish/unpublish if calling module is using Comment Approval System
+	* @return void
 	*/
 	function procCommentAdminChangePublishedStatusChecked()
 	{	// Error display if none is selected
@@ -38,6 +41,10 @@
 		}
 	}
 	
+	/**
+	* Change comment status
+	* @return void|object
+	*/
 	function procCommentAdminChangeStatus()
 	{
 		$will_publish = Context::get('will_publish');
@@ -149,9 +156,10 @@
 		
 	}
 	
-        /**
-         * @brief Delete the selected comment from the administrator page
-         **/
+		/**
+		 * Delete the selected comment from the administrator page
+		 * @return void
+		 */
         function procCommentAdminDeleteChecked() {
 			$isTrash = Context::get('is_trash');
 
@@ -228,6 +236,10 @@
 			}
         }
 
+		/**
+		 * comment move to trash
+		 * @return void|object
+		 */
 		function _moveCommentToTrash($commentSrlList, &$oCommentController, &$oDB)
 		{
 			require_once(_XE_PATH_.'modules/trash/model/TrashVO.php');
@@ -256,9 +268,10 @@
 			}
 		}
 
-        /**
-         * @brief cancel the blacklist of abused comments reported by other users
-         **/
+		/**
+		 * Cancel the blacklist of abused comments reported by other users
+		 * @return void|object
+		 */
         function procCommentAdminCancelDeclare() {
             $comment_srl = trim(Context::get('comment_srl'));
 
@@ -269,6 +282,10 @@
             }
         }
 
+		/**
+		 * Comment add to _SESSION
+		 * @return void
+		 */
 		function procCommentAdminAddCart()
 		{
 			$comment_srl = (int)Context::get('comment_srl');
@@ -289,9 +306,10 @@
 			}
 		}
 
-        /**
-         * @brief delete all comments of the specific module
-         **/
+		/**
+		 * Delete all comments of the specific module
+		 * @return object
+		 */
         function deleteModuleComments($module_srl) {
             $args->module_srl = $module_srl;
             $output = executeQuery('comment.deleteModuleComments', $args);
@@ -310,9 +328,10 @@
         }
 
         /**
-         * @brief restore comment from trash module, called by trash module
+         * Restore comment from trash module, called by trash module
 		 * this method is passived
-         **/
+		 * @return object
+         */
 		function restoreTrash($originObject)
 		{
 			if(is_array($originObject)) $originObject = (object)$originObject;
@@ -336,10 +355,11 @@
 			return $output;
 		}
 
-        /**
-         * @brief empty comment in trash, called by trash module
+		/**
+		 * Empty comment in trash, called by trash module
 		 * this method is passived
-         **/
+		 * @return object
+		 */
 		function emptyTrash($originObject)
 		{
 			$originObject = unserialize($originObject);