fix PHPDoc (artesaos#160)

klimov-paul · Aug 12, 2019 · 62b4235 · 62b4235
1 parent 8fa3a73
commit 62b4235
Show file tree

Hide file tree

Showing 10 changed files with 150 additions and 387 deletions.
diff --git a/src/SEOTools/Contracts/JsonLd.php b/src/SEOTools/Contracts/JsonLd.php
@@ -10,8 +10,10 @@ interface JsonLd
     public function __construct(array $defaults = []);
 
     /**
+     * Generates linked data script tag.
+     *
      * @param bool $minify
-     * 
+     *
      * @return string
      */
     public function generate($minify = false);
@@ -20,56 +22,56 @@ public function generate($minify = false);
      * @param string       $key
      * @param string|array $value
      *
-     * @return JsonLd
+     * @return static
      */
     public function addValue($key, $value);
 
     /**
      * @param string $type
      *
-     * @return JsonLd
+     * @return static
      */
     public function setType($type);
 
     /**
      * @param string $title
      *
-     * @return JsonLd
+     * @return static
      */
     public function setTitle($title);
 
     /**
      * @param string $site
      *
-     * @return JsonLd
+     * @return static
      */
     public function setSite($site);
 
     /**
      * @param string $description
      *
-     * @return JsonLd
+     * @return static
      */
     public function setDescription($description);
 
     /**
      * @param string $url
      *
-     * @return JsonLd
+     * @return static
      */
     public function setUrl($url);
 
     /**
      * @param string|array $image
      *
-     * @return JsonLd
+     * @return static
      */
     public function addImage($image);
 
     /**
      * @param string|array $images
      *
-     * @return JsonLd
+     * @return static
      */
     public function setImages($images);
 }
diff --git a/src/SEOTools/Contracts/MetaTags.php b/src/SEOTools/Contracts/MetaTags.php
@@ -9,14 +9,14 @@ interface MetaTags
     /**
      * Configuration.
      *
-     * @param Config $config
+     * @param \Illuminate\Config\Repository $config
      * @return void
      */
     public function __construct(Config $config);
 
     /**
      * Generates meta tags.
-     * 
+     *
      * @param bool $minify
      *
      * @return string
@@ -29,7 +29,7 @@ public function generate($minify = false);
      * @param string $title
      * @param bool   $appendDefault
      *
-     * @return MetaTags
+     * @return static
      */
     public function setTitle($title, $appendDefault = true);
 
@@ -38,7 +38,7 @@ public function setTitle($title, $appendDefault = true);
      *
      * @param string $default
      *
-     * @return MetaTags
+     * @return static
      */
     public function setTitleDefault($default);
 
@@ -47,7 +47,7 @@ public function setTitleDefault($default);
      *
      * @param string $separator
      *
-     * @return MetaTags
+     * @return static
      */
     public function setTitleSeparator($separator);
 
@@ -56,17 +56,17 @@ public function setTitleSeparator($separator);
      *
      * @param string $description
      *
-     * @return MetaTags
+     * @return static
      */
     public function setDescription($description);
 
     /**
      * Sets the list of keywords, you can send an array or string separated with commas
      * also clears the previously set keywords.
      *
-     * @param array $keywords
+     * @param string|array $keywords
      *
-     * @return MetaTags
+     * @return static
      */
     public function setKeywords($keywords);
 
@@ -75,7 +75,7 @@ public function setKeywords($keywords);
      *
      * @param string|array $keyword
      *
-     * @return MetaTags
+     * @return static
      */
     public function addKeyword($keyword);
 
@@ -84,7 +84,7 @@ public function addKeyword($keyword);
      *
      * @param string $key
      *
-     * @return MetaTags
+     * @return static
      */
     public function removeMeta($key);
 
@@ -95,7 +95,7 @@ public function removeMeta($key);
      * @param string       $value
      * @param string       $name
      *
-     * @return MetaTags
+     * @return static
      */
     public function addMeta($meta, $value = null, $name = 'name');
 
@@ -104,7 +104,7 @@ public function addMeta($meta, $value = null, $name = 'name');
      *
      * @param string $url
      *
-     * @return MetaTags
+     * @return static
      */
     public function setCanonical($url);
 
@@ -113,7 +113,7 @@ public function setCanonical($url);
      *
      * @param string $url
      *
-     * @return MetaTags
+     * @return static
      */
     public function setPrev($url);
 
@@ -122,7 +122,7 @@ public function setPrev($url);
      *
      * @param string $url
      *
-     * @return MetaTags
+     * @return static
      */
     public function setNext($url);
 
@@ -131,7 +131,8 @@ public function setNext($url);
      *
      * @param string $lang language code in format ISO 639-1
      * @param string $url
-     * @return MetaTags
+     *
+     * @return static
      */
     public function addAlternateLanguage($lang, $url);
 
@@ -140,7 +141,7 @@ public function addAlternateLanguage($lang, $url);
      *
      * @param array $languages
      *
-     * @return MetaTags
+     * @return static
      */
     public function addAlternateLanguages(array $languages);
 
@@ -182,7 +183,7 @@ public function getKeywords();
     /**
      * Get the Meta description.
      *
-     * @return string
+     * @return string|null
      */
     public function getDescription();