From a22196edaedcd977f117d083340d92cedd6738d3 Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Sun, 21 Oct 2018 07:53:16 -0400 Subject: [PATCH] Add/Fix Doxygen headers for classes --- src/Core/Addon.php | 5 +++++ src/Core/Hook.php | 12 ++++++++---- src/Database/DBA.php | 6 ++++++ 3 files changed, 19 insertions(+), 4 deletions(-) diff --git a/src/Core/Addon.php b/src/Core/Addon.php index 203119c91a..c3f559c708 100644 --- a/src/Core/Addon.php +++ b/src/Core/Addon.php @@ -255,6 +255,11 @@ class Addon extends BaseObject return in_array($addon, self::$addons); } + /** + * Returns a list of the enabled addon names + * + * @return array + */ public static function getEnabledList() { return self::$addons; diff --git a/src/Core/Hook.php b/src/Core/Hook.php index 839b55815a..85ed98e886 100644 --- a/src/Core/Hook.php +++ b/src/Core/Hook.php @@ -93,7 +93,7 @@ class Hook extends BaseObject /** * Returns the list of callbacks for a single hook * - * @param string $name + * @param string $name Name of the hook * @return array */ 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. * - * @param string $name of the hook to call - * @param string|array $data to transmit to the callback handler + * @param integer $priority of the hook + * @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) { @@ -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 + * + * @param string $name Name of the addon + * @return boolean */ public static function isAddonApp($name) { diff --git a/src/Database/DBA.php b/src/Database/DBA.php index 9baf409421..6249537c06 100644 --- a/src/Database/DBA.php +++ b/src/Database/DBA.php @@ -24,7 +24,13 @@ require_once 'include/dba.php'; */ class DBA { + /** + * Lowest possible date value + */ const NULL_DATE = '0001-01-01'; + /** + * Lowest possible datetime value + */ const NULL_DATETIME = '0001-01-01 00:00:00'; public static $connected = false;