Add phpdoc to non-static public methods

Stratadox · Apr 16, 2018 · b80a88f · b80a88f
1 parent ae747d4
commit b80a88f
Show file tree

Hide file tree

Showing 9 changed files with 20 additions and 4 deletions.
diff --git a/src/AlterableCollectionEntryUpdater.php b/src/AlterableCollectionEntryUpdater.php
@@ -51,6 +51,7 @@ public static function forThe(
         return new static($owner, $ofTheProperty, $atPosition, $setter);
     }
 
+    /** @inheritdoc */
     public function updateWith($theLoadedInstance): void
     {
         $this->setter->call($this->owner,

diff --git a/src/AlterableCollectionEntryUpdaterFactory.php b/src/AlterableCollectionEntryUpdaterFactory.php
@@ -12,7 +12,10 @@
  */
 final class AlterableCollectionEntryUpdaterFactory implements ProducesOwnerUpdaters
 {
-    // @todo allow passing the closure
+    /**
+     * @inheritdoc
+     * @todo allow passing the closure
+     */
     public function makeUpdaterFor(
         $owner,
         string $ofTheProperty,

diff --git a/src/ArrayEntryUpdater.php b/src/ArrayEntryUpdater.php
@@ -42,6 +42,7 @@ public static function forThe(
         return new static($owner, $ofTheProperty, $atPosition, $setter);
     }
 
+    /** @inheritdoc */
     public function updateWith($theLoadedInstance): void
     {
         $this->setter->call($this->owner,

diff --git a/src/ArrayEntryUpdaterFactory.php b/src/ArrayEntryUpdaterFactory.php
@@ -12,7 +12,10 @@
  */
 final class ArrayEntryUpdaterFactory implements ProducesOwnerUpdaters
 {
-    // @todo allow passing the closure
+    /**
+     * @inheritdoc
+     * @todo allow passing the closure
+     */
     public function makeUpdaterFor(
         $owner,
         string $ofTheProperty,

diff --git a/src/Loader.php b/src/Loader.php
@@ -36,16 +36,19 @@ public function __construct($forWhom, string $property, $position = null)
         $this->position = $position;
     }
 
+    /** @inheritdoc */
     public function attach(ObservesProxyLoading $observer): void
     {
         $this->observers[] = $observer;
     }
 
+    /** @inheritdoc */
     public function detach(ObservesProxyLoading $observer): void
     {
         unset($this->observers[array_search($observer, $this->observers)]);
     }
 
+    /** @inheritdoc */
     final public function loadTheInstance()
     {
         $instance = $this->doLoad($this->forWhom, $this->property, $this->position);

diff --git a/src/PropertyUpdater.php b/src/PropertyUpdater.php
@@ -38,6 +38,7 @@ public static function forThe(
         return new static($owner, $ofTheProperty, $setter);
     }
 
+    /** @inheritdoc */
     public function updateWith($theLoadedInstance): void
     {
         $this->setter->call($this->owner,

diff --git a/src/PropertyUpdaterFactory.php b/src/PropertyUpdaterFactory.php
@@ -12,7 +12,10 @@
  */
 final class PropertyUpdaterFactory implements ProducesOwnerUpdaters
 {
-    // @todo allow passing the closure
+    /**
+     * @inheritdoc
+     * @todo allow passing the closure
+     */
     public function makeUpdaterFor(
         $owner,
         string $ofTheProperty,

diff --git a/src/ProxyFactory.php b/src/ProxyFactory.php
@@ -36,6 +36,7 @@ public static function fromThis(
         return new static($proxies, $loaderFactory, $updaterFactory);
     }
 
+    /** @inheritdoc */
     public function createFor(
         $theOwner,
         string $ofTheProperty,

diff --git a/src/Proxying.php b/src/Proxying.php
@@ -23,7 +23,7 @@ trait Proxying
     /** @var object|null */
     private $instance;
 
-    /** @return self */
+    /** @return static */
     public function __load()
     {
         if (!$this->loader instanceof LoadsProxiedObjects) {