chore(emoji): 📚 🔬 Add comments to all the methods

unicodeveloper · unicodeveloper · commit 5e4e4b12aa88 · 2016-02-08T07:18:13.000+01:00
diff --git a/src/Emoji.php b/src/Emoji.php
@@ -7,21 +7,21 @@
 class Emoji {
 
     /**
-     * Quotes
-     * @var collection
-     */
-    protected $quotes;
-
-    /**
-     * Get the Quotes from the respective files depending on the Category
-     * @param  string $category
+     * Get the Emojis from emoji.php
      * @return array
      */
     private function getEmojis()
     {
         return require("Emojis/emoji.php");
     }
 
+    /**
+     * Get the emoji  by passing the commonly used emoji name
+     * @param  string $emojiName
+     * @return unicode
+     * @throws \Unicodeveloper\Emoji\Exceptions\IsNull
+     * @throws \Unicodeveloper\Emoji\Exceptions\UnknownUnicode
+     */
     public function findByAlias($emojiName = null)
     {
         if (is_null($emojiName)) {
@@ -37,11 +37,24 @@ public function findByAlias($emojiName = null)
         return $this->getEmojis()[$emoji];
     }
 
+    /**
+     * Get the emoji  by passing the commonly used emoji name
+     * Alias for findByAlias
+     * @param  string $emojiName
+     * @return unicode
+     */
     public function findByName($emojiName = null)
     {
         return $this->findByAlias($emojiName);
     }
 
+    /**
+     * Get the emoji name by passing the unicode value
+     * @param  string $unicode
+     * @return string
+     * @throws \Unicodeveloper\Emoji\Exceptions\IsNull
+     * @throws \Unicodeveloper\Emoji\Exceptions\UnknownUnicode
+     */
     public function findByUnicode($unicode = null)
     {
         if (is_null($unicode)) {
@@ -57,6 +70,12 @@ public function findByUnicode($unicode = null)
         return $emojis[$unicode];
     }
 
+    /**
+     * Ensure that a proper exception is thrown for methods that do not exist
+     * @param  string $method
+     * @param  array $parameters
+     * @throws \Unicodeveloper\Emoji\Exceptions\UnknownMethod
+     */
     public function __call($method, $parameters)
     {
         if (! method_exists(new static, $method)) {
