Add/Fix Doxygen headers for classes

This commit is contained in:
Hypolite Petovan 2018-10-21 07:53:16 -04:00
parent 9eaedc576c
commit a22196edae
3 changed files with 19 additions and 4 deletions

View file

@ -255,6 +255,11 @@ class Addon extends BaseObject
return in_array($addon, self::$addons); return in_array($addon, self::$addons);
} }
/**
* Returns a list of the enabled addon names
*
* @return array
*/
public static function getEnabledList() public static function getEnabledList()
{ {
return self::$addons; return self::$addons;

View file

@ -93,7 +93,7 @@ class Hook extends BaseObject
/** /**
* Returns the list of callbacks for a single hook * Returns the list of callbacks for a single hook
* *
* @param string $name * @param string $name Name of the hook
* @return array * @return array
*/ */
public static function getByName($name) public static function getByName($name)
@ -112,8 +112,9 @@ class Hook extends BaseObject
* *
* Use this function when you want to fork a hook via the worker. * Use this function when you want to fork a hook via the worker.
* *
* @param string $name of the hook to call * @param integer $priority of the hook
* @param string|array $data to transmit to the callback handler * @param string $name of the hook to call
* @param mixed $data to transmit to the callback handler
*/ */
public static function fork($priority, $name, $data = null) public static function fork($priority, $name, $data = null)
{ {
@ -169,8 +170,11 @@ class Hook extends BaseObject
} }
/** /**
* check if an app_menu hook exist for addon $name. * Checks if an app_menu hook exist for the provided addon name.
* Return true if the addon is an app * Return true if the addon is an app
*
* @param string $name Name of the addon
* @return boolean
*/ */
public static function isAddonApp($name) public static function isAddonApp($name)
{ {

View file

@ -24,7 +24,13 @@ require_once 'include/dba.php';
*/ */
class DBA class DBA
{ {
/**
* Lowest possible date value
*/
const NULL_DATE = '0001-01-01'; const NULL_DATE = '0001-01-01';
/**
* Lowest possible datetime value
*/
const NULL_DATETIME = '0001-01-01 00:00:00'; const NULL_DATETIME = '0001-01-01 00:00:00';
public static $connected = false; public static $connected = false;