Add doc comments for event methods

This commit is contained in:
netkas 2024-11-01 18:05:02 -04:00
parent cd691703ee
commit c7edc420f3
3 changed files with 11 additions and 1 deletions

View file

@ -16,6 +16,9 @@
return EventType::CHAT_BOOST_EVENT; return EventType::CHAT_BOOST_EVENT;
} }
/**
* @return ChatBoostUpdated The updated chat boost information.
*/
protected function getChatBoost(): ChatBoostUpdated protected function getChatBoost(): ChatBoostUpdated
{ {
return $this->update->getChatBoost(); return $this->update->getChatBoost();

View file

@ -14,6 +14,11 @@
return EventType::CHAT_JOIN_REQUEST_EVENT; 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 protected function getChatJoinRequest(): ChatJoinRequest
{ {
return $this->update->getChatJoinRequest(); return $this->update->getChatJoinRequest();

View file

@ -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 protected function getChatBoostRemoved(): ChatBoostRemoved
{ {