From 15fe1bc19e4bb42f6b39468f78f5024e86d404d0 Mon Sep 17 00:00:00 2001
From: chschy <chschy@gmail.com>
Date: Thu, 31 May 2012 07:25:35 +0000
Subject: [PATCH] added comments for phpDoc - integration_search module

git-svn-id: http://xe-core.googlecode.com/svn/branches/1.5.0@10758 201d5d3c-b55e-5fd7-737f-ddc643e51545
---
 .../integration_search.admin.controller.php   | 25 ++++---
 .../integration_search.admin.view.php         | 19 ++---
 .../integration_search.class.php              | 20 ++++--
 .../integration_search.model.php              | 71 ++++++++++++++++---
 .../integration_search.view.php               | 15 ++--
 5 files changed, 110 insertions(+), 40 deletions(-)

diff --git a/modules/integration_search/integration_search.admin.controller.php b/modules/integration_search/integration_search.admin.controller.php
index 0a1167117..c29397300 100644
--- a/modules/integration_search/integration_search.admin.controller.php
+++ b/modules/integration_search/integration_search.admin.controller.php
@@ -1,21 +1,24 @@
 <?php
     /**
-     * @class  integration_searchAdminController
-     * @author NHN (developers@xpressengine.com)
-     * @brief admin view class of the integration_search module
-     *
-     * Search Management
-     *
+     * The admin view class of the integration_search module
+	 *
+	 * @author NHN (developers@xpressengine.com)
      **/
 
     class integration_searchAdminController extends integration_search {
         /**
-         * @brief Initialization
+         * Initialization
+		 *
+		 * @return void
          **/
-        function init() {}
+        function init()
+		{
+		}
 
         /**
-         * @brief Save Settings
+         * Save Settings
+		 *
+		 * @return mixed
          **/
         function procIntegration_searchAdminInsertConfig() {
             // Get configurations (using module model object)
@@ -40,7 +43,9 @@
         }
 
         /**
-         * @brief Save the skin information
+         * Save the skin information
+		 *
+		 * @return mixed
          **/
         function procIntegration_searchAdminInsertSkin() {
             // Get configurations (using module model object)
diff --git a/modules/integration_search/integration_search.admin.view.php b/modules/integration_search/integration_search.admin.view.php
index 6abc799e6..02de5904d 100644
--- a/modules/integration_search/integration_search.admin.view.php
+++ b/modules/integration_search/integration_search.admin.view.php
@@ -1,11 +1,8 @@
 <?php
     /**
-     * @class  integration_searchAdminView
+     * The admin view class of the integration_search module
+	 *
      * @author NHN (developers@xpressengine.com)
-     * @brief admin view class of the integration_search module
-     *
-     * Search Management
-     *
      **/
 
     class integration_searchAdminView extends integration_search {
@@ -13,7 +10,9 @@
         var $config = null;
 
         /**
-         * @brief Initialization
+         * Initialization
+		 *
+		 * @return void
          **/
         function init() {
             // Get configurations (using module model object)
@@ -25,7 +24,9 @@
         }
 
         /**
-         * @brief Module selection and skin set
+         * Module selection and skin set
+		 *
+		 * @return Object
          **/
         function dispIntegration_searchAdminContent() {
             // Get a list of skins(themes)
@@ -60,7 +61,9 @@
         }
 
         /**
-         * @brief Skin Settings
+         * Skin Settings
+		 *
+		 * @return Object
          **/
         function dispIntegration_searchAdminSkinInfo() {
             $oModuleModel = &getModel('module');
diff --git a/modules/integration_search/integration_search.class.php b/modules/integration_search/integration_search.class.php
index f82c2aa0a..6ff8a5702 100644
--- a/modules/integration_search/integration_search.class.php
+++ b/modules/integration_search/integration_search.class.php
@@ -1,14 +1,16 @@
 <?php
     /**
-     * @class  integration_search
+     * The view class of the integration_search module
+	 *
      * @author NHN (developers@xpressengine.com)
-     * @brief view class of the integration_search module
      **/
 
     class integration_search extends ModuleObject {
 
         /**
-         * @brief Implement if additional tasks are necessary when installing
+         * Implement if additional tasks are necessary when installing
+		 *
+		 * @return Object
          **/
         function moduleInstall() {
             // Registered in action forward
@@ -19,21 +21,27 @@
         }
 
         /**
-         * @brief a method to check if successfully installed
+         * Check methoda whether successfully installed
+		 *
+		 * @return bool
          **/
         function checkUpdate() {
             return false;
         }
 
         /**
-         * @brief Execute update
+         * Execute update
+		 *
+		 * @return Object
          **/
         function moduleUpdate() {
             return new Object(0, 'success_updated');
         }
 
         /**
-         * @brief Re-generate the cache file
+         * Re-generate the cache file
+		 *
+		 * @return void
          **/
         function recompileCache() {
         }
diff --git a/modules/integration_search/integration_search.model.php b/modules/integration_search/integration_search.model.php
index 456c5e180..c25e37d26 100644
--- a/modules/integration_search/integration_search.model.php
+++ b/modules/integration_search/integration_search.model.php
@@ -1,19 +1,30 @@
 <?php
     /**
-     * @class  integrationModel
+     * The model class of integration module
+	 *
      * @author NHN (developers@xpressengine.com)
-     * @brief Model class of integration module
      **/
 
     class integration_searchModel extends module {
         /**
-         * @brief Initialization
+         * Initialization
+		 *
+		 * @return void
          **/
         function init() {
         }
 
         /**
-         * @brief Search documents
+         * Search documents
+		 *
+		 * @param string $target choose target. exclude or include for $module_srls_list
+		 * @param string $module_srls_list module_srl list to string type. ef - 102842,59392,102038
+		 * @param string $search_target Target
+		 * @param string $search_keyword Keyword
+		 * @param integer $page page of page navigation
+		 * @param integer $list_count list count of page navigation
+		 *
+		 * @return Object output document list
          **/
         function getDocuments($target, $module_srls_list, $search_target, $search_keyword, $page=1, $list_count = 20) {
             if(is_array($module_srls_list)) $module_srls_list = implode(',',$module_srls_list);
@@ -43,7 +54,15 @@
         }
 
         /**
-         * @brief Comment Search
+         * Search comment
+		 *
+		 * @param string $target choose target. exclude or include for $module_srls_list
+		 * @param string $module_srls_list module_srl list to string type. ef - 102842,59392,102038
+		 * @param string $search_keyword Keyword
+		 * @param integer $page page of page navigation
+		 * @param integer $list_count list count of page navigation
+		 *
+		 * @return Object output comment list
          **/
         function getComments($target, $module_srls_list, $search_keyword, $page=1, $list_count = 20) {
             if(is_array($module_srls_list)){
@@ -71,7 +90,16 @@
         }
 
         /**
-         * @brief Search trackbacks
+         * Search trackbacks
+		 *
+		 * @param string $target choose target. exclude or include for $module_srls_list
+		 * @param string $module_srls_list module_srl list to string type. ef - 102842,59392,102038
+		 * @param string $search_target Target
+		 * @param string $search_keyword Keyword
+		 * @param integer $page page of page navigation
+		 * @param integer $list_count list count of page navigation
+		 *
+		 * @return Object output trackback list
          **/
         function getTrackbacks($target, $module_srls_list, $search_target = "title", $search_keyword, $page=1, $list_count = 20) {
             if(is_array($module_srls_list)) $module_srls = implode(',',$module_srls_list);
@@ -93,7 +121,16 @@
         }
 
         /**
-         * @brief File Search
+         * Search file
+		 *
+		 * @param string $target choose target. exclude or include for $module_srls_list
+		 * @param string $module_srls_list module_srl list to string type. ef - 102842,59392,102038
+		 * @param string $search_keyword Keyword
+		 * @param integer $page page of page navigation
+		 * @param integer $list_count list count of page navigation
+		 * @param string $direct_download Y or N
+		 *
+		 * @return Object output file list
          **/
         function _getFiles($target, $module_srls_list, $search_keyword, $page, $list_count, $direct_download = 'Y') {
             if(is_array($module_srls_list)) $module_srls = implode(',',$module_srls_list);
@@ -176,14 +213,30 @@
         }
 
         /**
-         * @brief Multimedia Search
+         * Search Multimedia. call function _getFiles().
+		 *
+		 * @param string $target choose target. exclude or include for $module_srls_list
+		 * @param string $module_srls_list module_srl list to string type. ef - 102842,59392,102038
+		 * @param string $search_keyword Keyword
+		 * @param integer $page page of page navigation
+		 * @param integer $list_count list count of page navigation
+		 *
+		 * @return Object
          **/
         function getImages($target, $module_srls_list, $search_keyword, $page=1, $list_count = 20) {
             return $this->_getFiles($target, $module_srls_list, $search_keyword, $page, $list_count);
         }
 
         /**
-         * @brief Search for attachments
+         * Search for attachments. call function _getFiles().
+		 *
+		 * @param string $target choose target. exclude or include for $module_srls_list
+		 * @param string $module_srls_list module_srl list to string type. ef - 102842,59392,102038
+		 * @param string $search_keyword Keyword
+		 * @param integer $page page of page navigation
+		 * @param integer $list_count list count of page navigation
+		 *
+		 * @return Object
          **/
         function getFiles($target, $module_srls_list, $search_keyword, $page=1, $list_count = 20) {
             return $this->_getFiles($target, $module_srls_list, $search_keyword, $page, $list_count, 'N');
diff --git a/modules/integration_search/integration_search.view.php b/modules/integration_search/integration_search.view.php
index 19e85d709..1d1e1860a 100644
--- a/modules/integration_search/integration_search.view.php
+++ b/modules/integration_search/integration_search.view.php
@@ -1,11 +1,8 @@
 <?php
     /**
-     * @class  integration_searchView
+     * The view class of the integration_search module
+	 *
      * @author NHN (developers@xpressengine.com)
-     * @brief view class of the integration_search module
-     *
-     * Search Output
-     *
      **/
 
     class integration_searchView extends integration_search {
@@ -14,13 +11,17 @@
         var $skin = 'default';
 
         /**
-         * @brief Initialization
+         * Initialization
+		 *
+		 * @return void
          **/
         function init() {
         }
 
         /**
-         * @brief Search Result
+         * Search Result
+		 *
+		 * @return Object
          **/
         function IS() {
             $oFile = &getClass('file');