Fix docblocks types

diff --git a/boot.php b/boot.php
index 695f9e85c5b3519d83f01ff7080762e50bf5f41d..00058727f50142907da991b1698caae48e209286 100644 (file)
--- a/boot.php
+++ b/boot.php
@@ -524,6 +524,8 @@ function startup()
  * @brief Retrieve the App structure
  *
  * Useful in functions which require it but don't get it passed to them
+ *
+ * @return App
  */
 function get_app()
 {

diff --git a/include/text.php b/include/text.php
index 5cc573697dac656f1c97df0e211815dc4a44a24e..cbba8d0c5b501065c3ff451e14706be4ec9704a9 100644 (file)
--- a/include/text.php
+++ b/include/text.php
@@ -1701,7 +1701,7 @@ function array_xmlify($val){
 
 
 /**
- * transorm link href and img src from relative to absolute
+ * transform link href and img src from relative to absolute
  *
  * @param string $text
  * @param string $base base url

diff --git a/src/App.php b/src/App.php
index adea01a037e969ac76c5d83410efe298d62615ff..b16786140ad974a632b6036e4e135e8a5066b56f 100644 (file)
--- a/src/App.php
+++ b/src/App.php
@@ -619,7 +619,7 @@ class App {
         * If $name is not defined, return engine defined by theme,
         * or default
         *
-        * @param strin $name Template engine name
+        * @param string $name Template engine name
         * @return object Template Engine instance
         */
        function template_engine($name = '') {

diff --git a/src/Model/Contact.php b/src/Model/Contact.php
index aec417a65da990591bc61b26521aba5f5acb360b..1b15f1c76d89faafa38bae7187a7184552962ecd 100644 (file)
--- a/src/Model/Contact.php
+++ b/src/Model/Contact.php
@@ -197,7 +197,7 @@ class Contact extends BaseObject
         * up or some other transient event and that there's a possibility we could recover from it.
         *
         * @param array $contact contact to mark for archival
-        * @return type
+        * @return null
         */
        public static function markForArchival(array $contact)
        {

diff --git a/src/Model/GContact.php b/src/Model/GContact.php
index 56221244813c6e584bb9f6566732c868450f7da7..6c13c03b1eaa9b0a78d390fd5cd1ed278a57b1a7 100644 (file)
--- a/src/Model/GContact.php
+++ b/src/Model/GContact.php
@@ -636,7 +636,7 @@ class GContact
        /**
         * @brief Replace alternate OStatus user format with the primary one
         *
-        * @param arr $contact contact array (called by reference)
+        * @param array $contact contact array (called by reference)
         * @return void
         */
        public static function fixAlternateContactAddress(&$contact)
@@ -656,7 +656,7 @@ class GContact
        /**
         * @brief Fetch the gcontact id, add an entry if not existed
         *
-        * @param arr $contact contact array
+        * @param array $contact contact array
         *
         * @return bool|int Returns false if not found, integer if contact was found
         */
@@ -747,7 +747,7 @@ class GContact
        /**
         * @brief Updates the gcontact table from a given array
         *
-        * @param arr $contact contact array
+        * @param array $contact contact array
         *
         * @return bool|int Returns false if not found, integer if contact was found
         */
@@ -908,7 +908,7 @@ class GContact
        /**
         * @brief Updates the gcontact entry from probe
         *
-        * @param str $url profile link
+        * @param string $url profile link
         * @return void
         */
        public static function updateFromProbe($url)
@@ -974,7 +974,7 @@ class GContact
         *
         * If the "Statistics" plugin is enabled (See http://gstools.org/ for details) we query user data with this.
         *
-        * @param str $server Server address
+        * @param string $server Server address
         * @return void
         */
        public static function fetchGsUsers($server)

diff --git a/src/Model/Group.php b/src/Model/Group.php
index 209c78798bb430e78ee48d7bc54a8841ff034570..410f78b1564216ffb2dbd1ecd599ffccb3970492 100644 (file)
--- a/src/Model/Group.php
+++ b/src/Model/Group.php
@@ -131,7 +131,7 @@ class Group extends BaseObject
        /**
         * @brief Mark a group as deleted
         *
-        * @param type $gid
+        * @param int $gid
         * @return boolean
         */
        public static function remove($gid) {
@@ -176,9 +176,9 @@ class Group extends BaseObject
         *
         * @deprecated Use Group::remove instead
         *
-        * @param type $uid
-        * @param type $name
-        * @return type
+        * @param int $uid
+        * @param string $name
+        * @return bool
         */
        public static function removeByName($uid, $name) {
                $return = false;

diff --git a/src/Object/Image.php b/src/Object/Image.php
index b39945ede691756e757d702278a4b86d0279f53a..f979e4943863aa0d4827b55ab27b3fb7e9ca36db 100644 (file)
--- a/src/Object/Image.php
+++ b/src/Object/Image.php
@@ -111,7 +111,7 @@ class Image
 
        /**
         * @brief Maps Mime types to Imagick formats
-        * @return arr With with image formats (mime type as key)
+        * @return array With with image formats (mime type as key)
         */
        public static function getFormatsMap()
        {

diff --git a/src/ParseUrl.php b/src/ParseUrl.php
index c2c01b8aebede52a691aec790f4aef65e294c7e9..9e46281ec91a73ec6d159be72dc84068c91aaeb1 100644 (file)
--- a/src/ParseUrl.php
+++ b/src/ParseUrl.php
@@ -25,10 +25,10 @@ class ParseUrl
        /**
         * @brief Search for chached embeddable data of an url otherwise fetch it
         *
-        * @param type $url         The url of the page which should be scraped
-        * @param type $no_guessing If true the parse doens't search for
+        * @param string $url         The url of the page which should be scraped
+        * @param bool $no_guessing If true the parse doens't search for
         *                          preview pictures
-        * @param type $do_oembed   The false option is used by the function fetch_oembed()
+        * @param bool $do_oembed   The false option is used by the function fetch_oembed()
         *                          to avoid endless loops
         *
         * @return array which contains needed data for embedding
@@ -89,12 +89,12 @@ class ParseUrl
         * like \<title\>Awesome Title\</title\> or
         * \<meta name="description" content="An awesome description"\>
         *
-        * @param type $url         The url of the page which should be scraped
-        * @param type $no_guessing If true the parse doens't search for
+        * @param string $url         The url of the page which should be scraped
+        * @param bool $no_guessing If true the parse doens't search for
         *                          preview pictures
-        * @param type $do_oembed   The false option is used by the function fetch_oembed()
+        * @param bool $do_oembed   The false option is used by the function fetch_oembed()
         *                          to avoid endless loops
-        * @param type $count       Internal counter to avoid endless loops
+        * @param int $count       Internal counter to avoid endless loops
         *
         * @return array which contains needed data for embedding
         *    string 'url' => The url of the parsed page

diff --git a/src/Protocol/DFRN.php b/src/Protocol/DFRN.php
index e9df29625854379eee2910fcd0219beb981e8b91..ee5e76cb4e57ba9a54cb59d77c277f55bdeaf10d 100644 (file)
--- a/src/Protocol/DFRN.php
+++ b/src/Protocol/DFRN.php
@@ -1443,7 +1443,7 @@ class DFRN
         * @param bool   $onlyfetch Should the data only be fetched or should it update the contact record as well
         * @param string $xml       optional, default empty
         *
-        * @return Returns an array with relevant data of the author
+        * @return array Relevant data of the author
         * @todo Find good type-hints for all parameter
         */
        private static function fetchauthor($xpath, $context, $importer, $element, $onlyfetch, $xml = "")
@@ -1692,7 +1692,7 @@ class DFRN
         *
         * @param object $xpath    XPath object
         * @param object $activity Activity object
-        * @param text   $element  element name
+        * @param string $element  element name
         *
         * @return string XML string
         * @todo Find good type-hints for all parameter
@@ -2963,9 +2963,9 @@ class DFRN
        /**
         * @brief Imports a DFRN message
         *
-        * @param text  $xml          The DFRN message
-        * @param array $importer     Record of the importer user mixed with contact of the content
-        * @param bool  $sort_by_date Is used when feeds are polled
+        * @param string $xml          The DFRN message
+        * @param array  $importer     Record of the importer user mixed with contact of the content
+        * @param bool   $sort_by_date Is used when feeds are polled
         * @return integer Import status
         * @todo set proper type-hints
         */

diff --git a/src/Protocol/Diaspora.php b/src/Protocol/Diaspora.php
index 9090e4b6b283f0e16908deac9dbcc9e352a2e3fb..5ae63bd7a86d9e8993c5a9430966c248e0396085 100644 (file)
--- a/src/Protocol/Diaspora.php
+++ b/src/Protocol/Diaspora.php
@@ -928,10 +928,12 @@ class Diaspora
        /**
         * @brief Get a contact id for a given handle
         *
+        * @todo Move to Friendica\Model\Contact
+        *
         * @param int    $uid    The user id
         * @param string $handle The handle in the format user@domain.tld
         *
-        * @return The contact id
+        * @return int Contact id
         */
        private static function contactByHandle($uid, $handle)
        {
@@ -1113,7 +1115,7 @@ class Diaspora
         * @param string $body        The item body to replace links from
         * @param string $author_link The author link for missing local contact fallback
         *
-        * @return the replaced string
+        * @return string the replaced string
         */
        public static function replacePeopleGuid($body, $author_link)
        {

diff --git a/src/Util/XML.php b/src/Util/XML.php
index e5e649a07c81b6e75c856f6813e1b390e79bd8bd..bfd1b8bf5966ffb919e121c7e7484e1230b6dcc6 100644 (file)
--- a/src/Util/XML.php
+++ b/src/Util/XML.php
@@ -176,7 +176,7 @@ class XML
         * @param integer $recursion_depth recursion counter for internal use - default 0
         *                                 internal use, recursion counter
         *
-        * @return array | sring The array from the xml element or the string
+        * @return array | string The array from the xml element or the string
         */
        public static function elementToArray($xml_element, &$recursion_depth = 0)
        {

diff --git a/src/Worker/DiscoverPoCo.php b/src/Worker/DiscoverPoCo.php
index b3c03e905054b8c03c1d743fcdb4cd3365045281..b7b7f0a31c79bb192a8a36f6069a16cee17ae86d 100644 (file)
--- a/src/Worker/DiscoverPoCo.php
+++ b/src/Worker/DiscoverPoCo.php
@@ -268,7 +268,7 @@ class DiscoverPoCo {
        /**
         * @brief Search for GNU Social user with gstools.org
         *
-        * @param str $search User name
+        * @param string $search User name
         */
        private static function gsSearchUser($search) {