]> git.mxchange.org Git - friendica.git/commitdiff
Add/Fix Doxygen headers for classes
authorHypolite Petovan <hypolite@mrpetovan.com>
Sun, 21 Oct 2018 11:53:16 +0000 (07:53 -0400)
committerHypolite Petovan <hypolite@mrpetovan.com>
Mon, 22 Oct 2018 20:50:55 +0000 (16:50 -0400)
src/Core/Addon.php
src/Core/Hook.php
src/Database/DBA.php

index 203119c91a82eae93f263ba28d554dff21b1707d..c3f559c7087720ae972df14c341039f718045f58 100644 (file)
@@ -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;
index 839b55815a5d6f4dc3f4829da596ea06988fe5e7..85ed98e886b2d39ab6724dae72c658dc74d837f4 100644 (file)
@@ -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)
        {
index 9baf409421ed917e48d62e5dc4c7ae8ac681b111..6249537c06d7661c7f286e9e4bdf6c38b9fc25d0 100644 (file)
@@ -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;