Merge pull request #9 from ARCANEDEV/patch-2

Updating doc block comments
ARCANEDEV · Jun 21, 2016 · 9d75ba2 · 9d75ba2
2 parents f266ccf + 839d273
commit 9d75ba2
Show file tree

Hide file tree

Showing 13 changed files with 62 additions and 80 deletions.
diff --git a/src/Contracts/SeoHelper.php b/src/Contracts/SeoHelper.php
@@ -15,14 +15,14 @@ interface SeoHelper extends Renderable
     /**
      * Get SeoMeta instance.
      *
-     * @return SeoMeta
+     * @return \Arcanedev\SeoHelper\Contracts\SeoMeta
      */
     public function meta();
 
     /**
      * Set SeoMeta instance.
      *
-     * @param  SeoMeta  $seoMeta
+     * @param  \Arcanedev\SeoHelper\Contracts\SeoMeta  $seoMeta
      *
      * @return self
      */
@@ -31,23 +31,23 @@ public function setSeoMeta(SeoMeta $seoMeta);
     /**
      * Get SeoOpenGraph instance.
      *
-     * @return SeoOpenGraph
+     * @return \Arcanedev\SeoHelper\Contracts\SeoOpenGraph
      */
     public function openGraph();
 
     /**
      * Get SeoOpenGraph instance (alias).
      *
-     * @see    \Arcanedev\SeoHelper\SeoHelper::openGraph()
+     * @see    \Arcanedev\SeoHelper\Contracts\SeoHelper::openGraph()
      *
-     * @return SeoOpenGraph
+     * @return \Arcanedev\SeoHelper\Contracts\SeoOpenGraph
      */
     public function og();
 
     /**
      * Get SeoOpenGraph instance.
      *
-     * @param  SeoOpenGraph  $seoOpenGraph
+     * @param  \Arcanedev\SeoHelper\Contracts\SeoOpenGraph  $seoOpenGraph
      *
      * @return self
      */
@@ -56,14 +56,14 @@ public function setSeoOpenGraph(SeoOpenGraph $seoOpenGraph);
     /**
      * Get SeoTwitter instance.
      *
-     * @return SeoTwitter
+     * @return \Arcanedev\SeoHelper\Contracts\SeoTwitter
      */
     public function twitter();
 
     /**
      * Set SeoTwitter instance.
      *
-     * @param  SeoTwitter  $seoTwitter
+     * @param  \Arcanedev\SeoHelper\Contracts\SeoTwitter  $seoTwitter
      *
      * @return self
      */

diff --git a/src/Contracts/SeoMeta.php b/src/Contracts/SeoMeta.php
@@ -15,7 +15,7 @@ interface SeoMeta extends Renderable
     /**
      * Set the Title instance.
      *
-     * @param  Entities\TitleInterface  $title
+     * @param  \Arcanedev\SeoHelper\Contracts\Entities\TitleInterface  $title
      *
      * @return self
      */
@@ -24,7 +24,7 @@ public function title(Entities\TitleInterface $title);
     /**
      * Set the Description instance.
      *
-     * @param  Entities\DescriptionInterface  $description
+     * @param  \Arcanedev\SeoHelper\Contracts\Entities\DescriptionInterface  $description
      *
      * @return self
      */
@@ -33,7 +33,7 @@ public function description(Entities\DescriptionInterface $description);
     /**
      * Set the Keywords instance.
      *
-     * @param  Entities\KeywordsInterface  $keywords
+     * @param  \Arcanedev\SeoHelper\Contracts\Entities\KeywordsInterface  $keywords
      *
      * @return self
      */
@@ -42,7 +42,7 @@ public function keywords(Entities\KeywordsInterface $keywords);
     /**
      * Set the MiscTags instance.
      *
-     * @param  Entities\MiscTagsInterface  $misc
+     * @param  \Arcanedev\SeoHelper\Contracts\Entities\MiscTagsInterface  $misc
      *
      * @return self
      */
@@ -51,7 +51,7 @@ public function misc(Entities\MiscTagsInterface $misc);
     /**
      * Set the Webmasters instance.
      *
-     * @param  Entities\WebmastersInterface  $webmasters
+     * @param  \Arcanedev\SeoHelper\Contracts\Entities\WebmastersInterface  $webmasters
      *
      * @return self
      */

diff --git a/src/Contracts/SeoOpenGraph.php b/src/Contracts/SeoOpenGraph.php
@@ -17,7 +17,7 @@ interface SeoOpenGraph extends Renderable
     /**
      * Set the Open Graph instance.
      *
-     * @param  OpenGraphInterface  $openGraph
+     * @param  \Arcanedev\SeoHelper\Contracts\Entities\OpenGraphInterface  $openGraph
      *
      * @return self
      */

diff --git a/src/Contracts/SeoTwitter.php b/src/Contracts/SeoTwitter.php
@@ -17,7 +17,7 @@ interface SeoTwitter extends Renderable
     /**
      * Set the twitter card instance.
      *
-     * @param  Entities\TwitterCardInterface  $card
+     * @param  \Arcanedev\SeoHelper\Contracts\Entities\TwitterCardInterface  $card
      *
      * @return self
      */

diff --git a/src/Entities/MiscTags.php b/src/Entities/MiscTags.php
@@ -1,6 +1,5 @@
 <?php namespace Arcanedev\SeoHelper\Entities;
 
-use Arcanedev\SeoHelper\Contracts\Entities\MetaCollectionInterface;
 use Arcanedev\SeoHelper\Contracts\Entities\MiscTagsInterface;
 use Arcanedev\Support\Traits\Configurable;
 
@@ -32,7 +31,7 @@ class MiscTags implements MiscTagsInterface
     /**
      * Meta collection.
      *
-     * @var MetaCollectionInterface
+     * @var \Arcanedev\SeoHelper\Contracts\Entities\MetaCollectionInterface
      */
     protected $metas;
 

diff --git a/src/Entities/OpenGraph/Graph.php b/src/Entities/OpenGraph/Graph.php
@@ -24,7 +24,7 @@ class Graph implements OpenGraphInterface
     /**
      * The Open Graph meta collection.
      *
-     * @var MetaCollection
+     * @var \Arcanedev\SeoHelper\Contracts\Entities\MetaCollectionInterface
      */
     protected $metas;
 

diff --git a/src/Entities/Twitter/Card.php b/src/Entities/Twitter/Card.php
@@ -32,7 +32,7 @@ class Card implements TwitterCardInterface
     /**
      * Card meta collection.
      *
-     * @var MetaCollection
+     * @var \Arcanedev\SeoHelper\Contracts\Entities\MetaCollectionInterface
      */
     protected $metas;
 

diff --git a/src/Entities/Webmasters.php b/src/Entities/Webmasters.php
@@ -1,6 +1,5 @@
 <?php namespace Arcanedev\SeoHelper\Entities;
 
-use Arcanedev\SeoHelper\Contracts\Entities\MetaCollectionInterface;
 use Arcanedev\SeoHelper\Contracts\Entities\WebmastersInterface;
 use Arcanedev\Support\Traits\Configurable;
 
@@ -38,7 +37,7 @@ class Webmasters implements WebmastersInterface
     /**
      * The meta collection.
      *
-     * @var MetaCollectionInterface
+     * @var \Arcanedev\SeoHelper\Contracts\Entities\MetaCollectionInterface
      */
     protected $metas;
 

diff --git a/src/SeoHelper.php b/src/SeoHelper.php
@@ -15,21 +15,21 @@ class SeoHelper implements Contracts\SeoHelper
     /**
      * The SeoMeta instance.
      *
-     * @var Contracts\SeoMeta
+     * @var \Arcanedev\SeoHelper\Contracts\SeoMeta
      */
     private $seoMeta;
 
     /**
      * The SeoOpenGraph instance.
      *
-     * @var Contracts\SeoOpenGraph
+     * @var \Arcanedev\SeoHelper\Contracts\SeoOpenGraph
      */
     private $seoOpenGraph;
 
     /**
      * The SeoTwitter instance.
      *
-     * @var Contracts\SeoTwitter
+     * @var \Arcanedev\SeoHelper\Contracts\SeoTwitter
      */
     private $seoTwitter;
 
@@ -40,9 +40,9 @@ class SeoHelper implements Contracts\SeoHelper
     /**
      * Make SeoHelper instance.
      *
-     * @param  Contracts\SeoMeta       $seoMeta
-     * @param  Contracts\SeoOpenGraph  $seoOpenGraph
-     * @param  Contracts\SeoTwitter    $seoTwitter
+     * @param  \Arcanedev\SeoHelper\Contracts\SeoMeta       $seoMeta
+     * @param  \Arcanedev\SeoHelper\Contracts\SeoOpenGraph  $seoOpenGraph
+     * @param  \Arcanedev\SeoHelper\Contracts\SeoTwitter    $seoTwitter
      */
     public function __construct(
         Contracts\SeoMeta      $seoMeta,
@@ -61,7 +61,7 @@ public function __construct(
     /**
      * Get SeoMeta instance.
      *
-     * @return Contracts\SeoMeta
+     * @return \Arcanedev\SeoHelper\Contracts\SeoMeta
      */
     public function meta()
     {
@@ -71,7 +71,7 @@ public function meta()
     /**
      * Set SeoMeta instance.
      *
-     * @param  Contracts\SeoMeta  $seoMeta
+     * @param  \Arcanedev\SeoHelper\Contracts\SeoMeta  $seoMeta
      *
      * @return self
      */
@@ -85,7 +85,7 @@ public function setSeoMeta(Contracts\SeoMeta $seoMeta)
     /**
      * Get SeoOpenGraph instance.
      *
-     * @return Contracts\SeoOpenGraph
+     * @return \Arcanedev\SeoHelper\Contracts\SeoOpenGraph
      */
     public function openGraph()
     {
@@ -97,7 +97,7 @@ public function openGraph()
      *
      * @see    \Arcanedev\SeoHelper\SeoHelper::openGraph()
      *
-     * @return Contracts\SeoOpenGraph
+     * @return \Arcanedev\SeoHelper\Contracts\SeoOpenGraph
      */
     public function og()
     {
@@ -107,7 +107,7 @@ public function og()
     /**
      * Get SeoOpenGraph instance.
      *
-     * @param  Contracts\SeoOpenGraph  $seoOpenGraph
+     * @param  \Arcanedev\SeoHelper\Contracts\SeoOpenGraph  $seoOpenGraph
      *
      * @return self
      */
@@ -121,7 +121,7 @@ public function setSeoOpenGraph(Contracts\SeoOpenGraph $seoOpenGraph)
     /**
      * Get SeoTwitter instance.
      *
-     * @return Contracts\SeoTwitter
+     * @return \Arcanedev\SeoHelper\Contracts\SeoTwitter
      */
     public function twitter()
     {
@@ -131,7 +131,7 @@ public function twitter()
     /**
      * Set SeoTwitter instance.
      *
-     * @param  Contracts\SeoTwitter  $seoTwitter
+     * @param  \Arcanedev\SeoHelper\Contracts\SeoTwitter  $seoTwitter
      *
      * @return self
      */
@@ -164,7 +164,7 @@ public function setTitle($title, $siteName = null, $separator = null)
     /**
      * Set description.
      *
-     * @param  string $description
+     * @param  string  $description
      *
      * @return \Arcanedev\SeoHelper\Contracts\SeoHelper
      */

diff --git a/src/SeoHelperServiceProvider.php b/src/SeoHelperServiceProvider.php
@@ -82,15 +82,15 @@ public function provides()
     {
         return [
             'arcanedev.seo-helper',
-            \Arcanedev\SeoHelper\Contracts\SeoHelper::class,
+            Contracts\SeoHelper::class,
 
             // Utilities
             'arcanedev.seo-helper.meta',
             'arcanedev.seo-helper.open-graph',
             'arcanedev.seo-helper.twitter',
-            \Arcanedev\SeoHelper\Contracts\SeoMeta::class,
-            \Arcanedev\SeoHelper\Contracts\SeoOpenGraph::class,
-            \Arcanedev\SeoHelper\Contracts\SeoTwitter::class,
+            Contracts\SeoMeta::class,
+            Contracts\SeoOpenGraph::class,
+            Contracts\SeoTwitter::class,
         ];
     }
 
@@ -103,14 +103,7 @@ public function provides()
      */
     private function registerSeoHelperService()
     {
-        $this->singleton(
-            'arcanedev.seo-helper',
-            \Arcanedev\SeoHelper\SeoHelper::class
-        );
-
-        $this->bind(
-            \Arcanedev\SeoHelper\Contracts\SeoHelper::class,
-            'arcanedev.seo-helper'
-        );
+        $this->singleton('arcanedev.seo-helper', SeoHelper::class);
+        $this->bind(Contracts\SeoHelper::class, 'arcanedev.seo-helper');
     }
 }