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
This commit is contained in:
chschy 2012-05-31 07:25:35 +00:00
parent 32284aa5a7
commit 15fe1bc19e
5 changed files with 110 additions and 40 deletions

View file

@ -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() {
}