add phpDoc comment in menu module

git-svn-id: http://xe-core.googlecode.com/svn/branches/1.5.0@10792 201d5d3c-b55e-5fd7-737f-ddc643e51545
This commit is contained in:
ovclas 2012-06-25 09:30:08 +00:00
parent e7e74da1f8
commit 19a7be5b1f
5 changed files with 296 additions and 157 deletions

View file

@ -1,15 +1,17 @@
<?php
/**
* @class menu
* @author NHN (developers@xpressengine.com)
* @brief high class of the menu module
**/
/**
* menu class
* high class of the menu module
*
* @author NHN (developers@xpressengine.com)
* @package /modules/menu
* @version 0.1
*/
class menu extends ModuleObject {
/**
* @brief Implement if additional tasks are necessary when installing
**/
/**
* Implement if additional tasks are necessary when installing
* @return Object
*/
function moduleInstall() {
// Create a directory to use menu
FileHandler::makeDir('./files/cache/menu');
@ -17,9 +19,10 @@
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();
// 2009. 02. 11 menu added to the table site_srl
@ -30,9 +33,10 @@
return false;
}
/**
* @brief Execute update
**/
/**
* Execute update
* @return Object
*/
function moduleUpdate() {
$oDB = &DB::getInstance();
// 2009. 02. 11 menu added to the table site_srl
@ -48,9 +52,10 @@
return new Object(0, 'success_updated');
}
/**
* @brief Re-generate the cache file
**/
/**
* Re-generate the cache file
* @return void
*/
function recompileCache() {
$oMenuAdminController = &getAdminController('menu');
// Wanted list of all the blog module