Fix PHPDoc comments project-wide

[friendica.git] / src / Util / ParseUrl.php

diff --git a/src/Util/ParseUrl.php b/src/Util/ParseUrl.php
index cdafc7387b800b7b8019ffc394981066aef38ac9..e2bd1e4e5bbb6f2549a00a62404ca37cc3cb8a89 100644 (file)
--- a/src/Util/ParseUrl.php
+++ b/src/Util/ParseUrl.php
@@ -22,10 +22,10 @@ class ParseUrl
         * @brief Search for chached embeddable data of an url otherwise fetch it
         *
         * @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 bool $do_oembed   The false option is used by the function fetch_oembed()
-        *                          to avoid endless loops
+        * @param bool   $no_guessing If true the parse doens't search for
+        *                            preview pictures
+        * @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
         *    string 'url' => The url of the parsed page
@@ -37,7 +37,8 @@ class ParseUrl
         *    array'images' = Array of preview pictures
         *    string 'keywords' => The tags which belong to the content
         *
-        * @see ParseUrl::getSiteinfo() for more information about scraping
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @see   ParseUrl::getSiteinfo() for more information about scraping
         * embeddable content
         */
        public static function getSiteinfoCached($url, $no_guessing = false, $do_oembed = true)
@@ -68,6 +69,7 @@ class ParseUrl
 
                return $data;
        }
+
        /**
         * @brief Parse a page for embeddable content information
         *
@@ -79,11 +81,11 @@ class ParseUrl
         * \<meta name="description" content="An awesome description"\>
         *
         * @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 bool $do_oembed   The false option is used by the function fetch_oembed()
-        *                          to avoid endless loops
-        * @param int $count       Internal counter to avoid endless loops
+        * @param bool   $no_guessing If true the parse doens't search for
+        *                            preview pictures
+        * @param bool   $do_oembed   The false option is used by the function fetch_oembed()
+        *                            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
@@ -95,7 +97,8 @@ class ParseUrl
         *    array'images' = Array of preview pictures
         *    string 'keywords' => The tags which belong to the content
         *
-        * @todo https://developers.google.com/+/plugins/snippet/
+        * @throws \Friendica\Network\HTTPException\InternalServerErrorException
+        * @todo  https://developers.google.com/+/plugins/snippet/
         * @verbatim
         * <meta itemprop="name" content="Awesome title">
         * <meta itemprop="description" content="An awesome description">