Move PHPDoc for toggle() method in the interface

SharkEzz · Jan 1, 2021 · 68b72d9 · 68b72d9
1 parent a3a84b5
commit 68b72d9
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -42,6 +42,9 @@ It can as well be used in your 'from scratch' project or in the framework of you
 
 <a name="implemented-methods"></a>
 ### Currently implemented methods
+
+*This list is temporary, expect more methods to come*
+
 - [x] Set the color (RGB) of the light
 - [x] Set the light brightness
 - [x] Set the light name

diff --git a/src/Interfaces/YeePHPInterface.php b/src/Interfaces/YeePHPInterface.php
@@ -59,7 +59,8 @@ public function getName(): string;
     /**
      * Toggle the light
      *
-     * @return bool
+     * @deprecated Please use the setPower() method instead
+     * @return YeePHPInterface
      */
     public function toggle(): self;
 

diff --git a/src/YeePHP.php b/src/YeePHP.php
@@ -145,7 +145,7 @@ public function getName(): string
     }
 
     /**
-     * @deprecated Please use the setPower() method instead
+     * @inheritDoc
      */
     public function toggle(): self
     {