summaryrefslogtreecommitdiff
path: root/include/tgbot/EventBroadcaster.h
diff options
context:
space:
mode:
authorJellyBrick <shlee1503@naver.com>2018-05-29 20:22:58 +0900
committerJellyBrick <shlee1503@naver.com>2018-05-29 20:22:58 +0900
commit1107db6e8890774fc55fa43160b0afa442443056 (patch)
treecdd8284e70bba788e0048cc0a717ad4656c285a0 /include/tgbot/EventBroadcaster.h
parent381a1cd0d949db88abd0b28bc717a8690b93ccc0 (diff)
Added @brief to the Doxygen comment.
Diffstat (limited to 'include/tgbot/EventBroadcaster.h')
-rw-r--r--include/tgbot/EventBroadcaster.h17
1 files changed, 9 insertions, 8 deletions
diff --git a/include/tgbot/EventBroadcaster.h b/include/tgbot/EventBroadcaster.h
index 2bb2d2a..5a41c70 100644
--- a/include/tgbot/EventBroadcaster.h
+++ b/include/tgbot/EventBroadcaster.h
@@ -38,7 +38,8 @@ namespace TgBot {
class EventHandler;
/**
- * This class holds all event listeners.
+ * @brief This class holds all event listeners.
+ *
* @ingroup general
*/
class EventBroadcaster {
@@ -52,7 +53,7 @@ public:
typedef std::function<void (const CallbackQuery::Ptr)> CallbackQueryListener;
/**
- * Registers listener which receives all messages which the bot can ever receive.
+ * @brief Registers listener which receives all messages which the bot can ever receive.
* @param listener Listener.
*/
inline void onAnyMessage(const MessageListener& listener) {
@@ -60,7 +61,7 @@ public:
}
/**
- * Registers listener which receives all messages with commands (messages with leading '/' char).
+ * @brief Registers listener which receives all messages with commands (messages with leading '/' char).
* @param commandName Command name which listener can handle.
* @param listener Listener.
*/
@@ -69,7 +70,7 @@ public:
}
/**
- * Registers listener which receives all messages with commands (messages with leading '/' char).
+ * @brief Registers listener which receives all messages with commands (messages with leading '/' char).
* @param commandsList Commands names which listener can handle.
* @param listener Listener.
*/
@@ -81,7 +82,7 @@ public:
}
/**
- * Registers listener which receives all messages with commands (messages with leading '/' char) which haven't been handled by other listeners.
+ * @brief Registers listener which receives all messages with commands (messages with leading '/' char) which haven't been handled by other listeners.
* @param listener Listener.
*/
inline void onUnknownCommand(const MessageListener& listener) {
@@ -89,7 +90,7 @@ public:
}
/**
- * Registers listener which receives all messages without commands (messages with no leading '/' char)
+ * @brief Registers listener which receives all messages without commands (messages with no leading '/' char)
* @param listener Listener.
*/
inline void onNonCommandMessage(const MessageListener& listener) {
@@ -97,7 +98,7 @@ public:
}
/**
- * Registers listener which receives all the inline query.
+ * @brief Registers listener which receives all the inline query.
* @param listener Listener.
*/
inline void onInlineQuery(const InlineQueryListener& listener) {
@@ -105,7 +106,7 @@ public:
}
/**
- * Registers listener which receives all the chosen inline result.
+ * @brief Registers listener which receives all the chosen inline result.
* @param listener Listener.
*/
inline void onChosenInlineResult(const ChosenInlineResultListener& listener){