add phpDoc comment in trash module

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

modules/trash/trash.admin.controller.php

@@ -1,15 +1,19 @@
 <?php
 /**
- * @class  documentController
+ * trashAdminController class
+ * trash admin the module's controller class
+ *
  * @author NHN (developers@xpressengine.com)
- * @brief document the module's controller class
+ * @package /modules/trash
- **/
+ * @version 0.1
+ */
 class trashAdminController extends trash
 {
 	/**
-	 * @brief object insert to trash
+	 * object insert to trash
-	 * @param $obj : TrashVO type object
+	 * @param TrashVO $obj
-	 **/
+	 * @return Object
+	 */
 	function insertTrash($obj)
 	{
 		if(Context::get('is_logged'))
@@ -32,9 +36,10 @@ class trashAdminController extends trash
 	}
 
 	/**
-	 * @brief empty trash
+	 * Empty trash
-	 * @param trashSrls : trash_srl in array
+	 * @param array trashSrls
-	 **/
+	 * @return Object
+	 */
 	function procTrashAdminEmptyTrash()
 	{
 		global $lang;
@@ -60,8 +65,11 @@ class trashAdminController extends trash
 	}
 
 	/**
-	 * @brief empty trash - private method
+	 * Empty trash - private method
-	 **/
+	 * @param string $isAll
+	 * @param array trashSrls
+	 * @return Object
+	 */
 	function _relationDataDelete($isAll, &$trashSrls)
 	{
 		if($isAll == 'true') $trashSrls = array();
@@ -95,8 +103,9 @@ class trashAdminController extends trash
 	}
 
 	/**
-	 * @brief restore content object
+	 * Restore content object
-	 **/
+	 * @return void|Object
+	 */
 	function procTrashAdminRestore()
 	{
 		global $lang;
@@ -150,6 +159,10 @@ class trashAdminController extends trash
 		}
 	}
 
+	/**
+	 * Set trash list to Context
+	 * @return void|Object
+	 */
 	function procTrashAdminGetList()
 	{
 		if(!Context::get('is_logged')) return new Object(-1,'msg_not_permitted');
@@ -173,9 +186,10 @@ class trashAdminController extends trash
 	}
 
 	/**
-	 * @brief empty trash
+	 * empty trash
-	 * @param trashSrls : trash_srl in array
+	 * @param array trashSrls
-	 **/
+	 * @return bool
+	 */
 	function _emptyTrash($trashSrls)
 	{
 		if(!is_array($trashSrls)) return false;

modules/trash/trash.admin.view.php

@@ -1,15 +1,17 @@
 <?php
 /**
- * @class  trashView
+ * trashAdminView class
+ * Admin view class of the trash module
+ *
  * @author NHN (developers@xpressengine.com)
- * @brief View class of the module trash
+ * @package /modules/trash
- **/
+ * @version 0.1
-
+ */
 class trashAdminView extends trash {
-
 	/**
-	 * @brief Initialization
+	 * Initialization
-	 **/
+	 * @return void
+	 */
 	function init() {
 		// 템플릿 경로 지정 (board의 경우 tpl에 관리자용 템플릿 모아놓음)
 		$template_path = sprintf("%stpl/",$this->module_path);
@@ -17,8 +19,9 @@ class trashAdminView extends trash {
 	}
 
 	/**
-	 * @brief trash list
+	 * Trash list
-	 **/
+	 * @return void
+	 */
 	function dispTrashAdminList() {
 		$args->page = Context::get('page'); // /< Page
 		$args->list_count = 30; // /< the number of posts to display on a single page

modules/trash/trash.class.php

@@ -1,23 +1,28 @@
 <?php
 /**
- * @class  document
+ * trash class
+ * trash the module's high class
+ *
  * @author NHN (developers@xpressengine.com)
- * @brief document the module's high class
+ * @package /modules/trash
- **/
+ * @version 0.1
+ */
 
 require_once(_XE_PATH_.'modules/trash/model/TrashVO.php');
 
 class trash extends ModuleObject {
 	/**
-	 * @brief Implement if additional tasks are necessary when installing
+	 * Implement if additional tasks are necessary when installing
-	 **/
+	 * @return Object
+	 */
 	function moduleInstall() {
 		return new Object();
 	}
 
 	/**
-	 * @brief a method to check if successfully installed
+	 * A method to check if successfully installed
-	 **/
+	 * @return bool
+	 */
 	function checkUpdate() {
 		//$oDB = &DB::getInstance();
 		//$oModuleModel = &getModel('module');
@@ -26,8 +31,9 @@ class trash extends ModuleObject {
 	}
 
 	/**
-	 * @brief Execute update
+	 * Execute update
-	 **/
+	 * @return Object
+	 */
 	function moduleUpdate() {
 		//$oDB = &DB::getInstance();
 		//$oModuleModel = &getModel('module');

modules/trash/trash.controller.php

@@ -1,9 +1,12 @@
 <?php
 /**
- * @class  documentController
+ * trashController
+ * trash the module's controller class
+ *
  * @author NHN (developers@xpressengine.com)
- * @brief document the module's controller class
+ * @package /modules/trash
- **/
+ * @version 0.1
+ */
 class trashController extends trash
 {
 }

modules/trash/trash.model.php

@@ -1,10 +1,20 @@
 <?php
-
+/**
+ * trashModel class
+ * trash the module's model class
+ *
+ * @author NHN (developers@xpressengine.com)
+ * @package /modules/trash
+ * @version 0.1
+ */
 class trashModel extends trash
 {
 	/**
-	 * @brief get one trash object
+	 * Get one trash object
-	 **/
+	 * @param int $trashSrl
+	 * @pram array $columnList
+	 * @return TrashVO
+	 */
 	function getTrash($trashSrl, $columnList = array())
 	{
 		$oTrashVO = new TrashVO();
@@ -20,8 +30,11 @@ class trashModel extends trash
 	}
 
 	/**
-	 * @brief get trash object list
+	 * Get TrashVO list
-	 **/
+	 * @param object $args
+	 * @param array $columnList
+	 * @return object
+	 */
 	function getTrashList($args, $columnList = array())
 	{
 		$output = executeQueryArray('trash.getTrashList', $args, $columnList);
@@ -39,8 +52,11 @@ class trashModel extends trash
 	}
 
 	/**
-	 * @brief set trash object from std object
+	 * Set trash object from std object
-	 **/
+	 * @param TrashVO $oTrashVO
+	 * @param object $stdObject
+	 * @return void
+	 */
 	function _setTrashObject(&$oTrashVO, $stdObject)
 	{
 		$oTrashVO->setTrashSrl($stdObject->trash_srl);

modules/trash/trash.view.php

@@ -1,15 +1,17 @@
 <?php
 /**
- * @class  trashView
+ * trashView class
+ * View class of the module trash
+ *
  * @author NHN (developers@xpressengine.com)
- * @brief View class of the module trash
+ * @package /modules/trash
- **/
+ * @version 0.1
-
+ */
 class trashView extends trash {
-
 	/**
-	 * @brief Initialization
+	 * Initialization
-	 **/
+	 * @return void
+	 */
 	function init() {
 	}
 }