From c7edc420f3c8f5bb016601394e78e1790cc1b838 Mon Sep 17 00:00:00 2001
From: netkas <netkas@n64.cc>
Date: Fri, 1 Nov 2024 18:05:02 -0400
Subject: [PATCH] Add doc comments for event methods

---
 src/TgBotLib/Events/ChatBoostEvent.php        | 3 +++
 src/TgBotLib/Events/ChatJoinRequestEvent.php  | 5 +++++
 src/TgBotLib/Events/RemovedChatBoostEvent.php | 4 +++-
 3 files changed, 11 insertions(+), 1 deletion(-)

diff --git a/src/TgBotLib/Events/ChatBoostEvent.php b/src/TgBotLib/Events/ChatBoostEvent.php
index b5f6c55..0eeb631 100644
--- a/src/TgBotLib/Events/ChatBoostEvent.php
+++ b/src/TgBotLib/Events/ChatBoostEvent.php
@@ -16,6 +16,9 @@
             return EventType::CHAT_BOOST_EVENT;
         }
 
+        /**
+         * @return ChatBoostUpdated The updated chat boost information.
+         */
         protected function getChatBoost(): ChatBoostUpdated
         {
             return $this->update->getChatBoost();
diff --git a/src/TgBotLib/Events/ChatJoinRequestEvent.php b/src/TgBotLib/Events/ChatJoinRequestEvent.php
index 1f7e6d6..fe041bd 100644
--- a/src/TgBotLib/Events/ChatJoinRequestEvent.php
+++ b/src/TgBotLib/Events/ChatJoinRequestEvent.php
@@ -14,6 +14,11 @@
             return EventType::CHAT_JOIN_REQUEST_EVENT;
         }
 
+        /**
+         * Retrieves the chat join request from the update.
+         *
+         * @return ChatJoinRequest The chat join request data.
+         */
         protected function getChatJoinRequest(): ChatJoinRequest
         {
             return $this->update->getChatJoinRequest();
diff --git a/src/TgBotLib/Events/RemovedChatBoostEvent.php b/src/TgBotLib/Events/RemovedChatBoostEvent.php
index 8472f56..4b86d13 100644
--- a/src/TgBotLib/Events/RemovedChatBoostEvent.php
+++ b/src/TgBotLib/Events/RemovedChatBoostEvent.php
@@ -17,7 +17,9 @@
         }
 
         /**
-         * @return ChatBoostRemoved The object representing the removed chat boost.
+         * Retrieves the removed chat boost from the update.
+         *
+         * @return ChatBoostRemoved The chat boost that was removed.
          */
         protected function getChatBoostRemoved(): ChatBoostRemoved
         {