summaryrefslogtreecommitdiff
path: root/include/tgbot
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
parent381a1cd0d949db88abd0b28bc717a8690b93ccc0 (diff)
Added @brief to the Doxygen comment.
Diffstat (limited to 'include/tgbot')
-rw-r--r--include/tgbot/Api.h151
-rw-r--r--include/tgbot/Bot.h3
-rw-r--r--include/tgbot/EventBroadcaster.h17
-rw-r--r--include/tgbot/TgException.h3
-rw-r--r--include/tgbot/net/HttpClient.h8
-rw-r--r--include/tgbot/net/HttpReqArg.h13
-rw-r--r--include/tgbot/net/HttpServer.h7
-rw-r--r--include/tgbot/net/TgLongPoll.h5
-rw-r--r--include/tgbot/net/TgWebhookLocalServer.h3
-rw-r--r--include/tgbot/net/Url.h13
-rw-r--r--include/tgbot/types/Audio.h15
-rw-r--r--include/tgbot/types/CallbackQuery.h16
-rw-r--r--include/tgbot/types/Chat.h30
-rw-r--r--include/tgbot/types/ChatMember.h34
-rw-r--r--include/tgbot/types/ChatPhoto.h6
-rw-r--r--include/tgbot/types/ChosenInlineResult.h14
-rw-r--r--include/tgbot/types/Contact.h11
-rw-r--r--include/tgbot/types/Document.h13
-rw-r--r--include/tgbot/types/File.h11
-rw-r--r--include/tgbot/types/ForceReply.h8
-rw-r--r--include/tgbot/types/GenericReply.h2
-rw-r--r--include/tgbot/types/InlineKeyboardButton.h13
-rw-r--r--include/tgbot/types/InlineKeyboardMarkup.h5
-rw-r--r--include/tgbot/types/InlineQuery.h13
-rw-r--r--include/tgbot/types/InlineQueryResult.h15
-rw-r--r--include/tgbot/types/InlineQueryResultArticle.h15
-rw-r--r--include/tgbot/types/InlineQueryResultAudio.h9
-rw-r--r--include/tgbot/types/InlineQueryResultCachedAudio.h5
-rw-r--r--include/tgbot/types/InlineQueryResultCachedDocument.h7
-rw-r--r--include/tgbot/types/InlineQueryResultCachedGif.h5
-rw-r--r--include/tgbot/types/InlineQueryResultCachedMpeg4Gif.h5
-rw-r--r--include/tgbot/types/InlineQueryResultCachedPhoto.h7
-rw-r--r--include/tgbot/types/InlineQueryResultCachedSticker.h5
-rw-r--r--include/tgbot/types/InlineQueryResultCachedVideo.h9
-rw-r--r--include/tgbot/types/InlineQueryResultCachedVoice.h5
-rw-r--r--include/tgbot/types/InlineQueryResultContact.h15
-rw-r--r--include/tgbot/types/InlineQueryResultDocument.h15
-rw-r--r--include/tgbot/types/InlineQueryResultGame.h5
-rw-r--r--include/tgbot/types/InlineQueryResultGif.h13
-rw-r--r--include/tgbot/types/InlineQueryResultLocation.h13
-rw-r--r--include/tgbot/types/InlineQueryResultMpeg4Gif.h13
-rw-r--r--include/tgbot/types/InlineQueryResultPhoto.h13
-rw-r--r--include/tgbot/types/InlineQueryResultVenue.h17
-rw-r--r--include/tgbot/types/InlineQueryResultVideo.h17
-rw-r--r--include/tgbot/types/InlineQueryResultVoice.h7
-rw-r--r--include/tgbot/types/InputContactMessageContent.h19
-rw-r--r--include/tgbot/types/InputFile.h11
-rw-r--r--include/tgbot/types/InputLocationMessageContent.h15
-rw-r--r--include/tgbot/types/InputMedia.h23
-rw-r--r--include/tgbot/types/InputMediaPhoto.h6
-rw-r--r--include/tgbot/types/InputMediaVideo.h6
-rw-r--r--include/tgbot/types/InputMessageContent.h6
-rw-r--r--include/tgbot/types/InputTextMessageContent.h19
-rw-r--r--include/tgbot/types/InputVenueMessageContent.h25
-rw-r--r--include/tgbot/types/KeyboardButton.h10
-rw-r--r--include/tgbot/types/Location.h7
-rw-r--r--include/tgbot/types/MaskPosition.h11
-rw-r--r--include/tgbot/types/Message.h79
-rw-r--r--include/tgbot/types/MessageEntity.h13
-rw-r--r--include/tgbot/types/PhotoSize.h11
-rw-r--r--include/tgbot/types/ReplyKeyboardMarkup.h12
-rw-r--r--include/tgbot/types/ReplyKeyboardRemove.h10
-rw-r--r--include/tgbot/types/ResponseParameters.h8
-rw-r--r--include/tgbot/types/Sticker.h19
-rw-r--r--include/tgbot/types/StickerSet.h11
-rw-r--r--include/tgbot/types/Update.h19
-rw-r--r--include/tgbot/types/User.h15
-rw-r--r--include/tgbot/types/UserProfilePhotos.h7
-rw-r--r--include/tgbot/types/Venue.h11
-rw-r--r--include/tgbot/types/Video.h17
-rw-r--r--include/tgbot/types/VideoNote.h13
-rw-r--r--include/tgbot/types/Voice.h11
-rw-r--r--include/tgbot/types/WebhookInfo.h17
73 files changed, 577 insertions, 483 deletions
diff --git a/include/tgbot/Api.h b/include/tgbot/Api.h
index ffce252..f3b4957 100644
--- a/include/tgbot/Api.h
+++ b/include/tgbot/Api.h
@@ -48,7 +48,8 @@ namespace TgBot {
class Bot;
/**
- * This class executes telegram api methods. Telegram docs: <https://core.telegram.org/bots/api#available-methods>
+ * @brief This class executes telegram api methods. Telegram docs: <https://core.telegram.org/bots/api#available-methods>
+ *
* @ingroup general
*/
class Api {
@@ -61,13 +62,13 @@ public:
Api(const std::string& token);
/**
- * A simple method for testing your bot's auth token.
+ * @brief A simple method for testing your bot's auth token.
* @return Basic information about the bot in form of a User object.
*/
User::Ptr getMe() const;
/**
- * Use this method to send text messages.
+ * @brief Use this method to send text messages.
* @param chatId Unique identifier for the target chat.
* @param text Text of the message to be sent.
* @param disableWebPagePreview Optional. Disables link previews for links in this message.
@@ -81,7 +82,7 @@ public:
const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const;
/**
- * Use this method to forward messages of any kind.
+ * @brief Use this method to forward messages of any kind.
* @param chatId Unique identifier for the target chat.
* @param fromChatId Unique identifier for the chat where the original message was sent — User or GroupChat id.
* @param messageId Unique message identifier.
@@ -91,7 +92,7 @@ public:
Message::Ptr forwardMessage(int64_t chatId, int64_t fromChatId, int32_t messageId, bool disableNotification = false) const;
/**
- * Use this method to send photos.
+ * @brief Use this method to send photos.
* @param chatId Unique identifier for the target chat.
* @param photo Photo to send.
* @param caption Optional. Photo caption.
@@ -105,7 +106,7 @@ public:
const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const;
/**
- * Use this method to send photos.
+ * @brief Use this method to send photos.
* @param chatId Unique identifier for the target chat.
* @param photo Photo to send. Id of the photo that is already on the Telegram servers.
* @param caption Optional. Photo caption.
@@ -119,7 +120,7 @@ public:
const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const;
/**
- * Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Document).
+ * @brief Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Document).
* @param chatId Unique identifier for the target chat.
* @param audio Audio to send.
* @param caption Audio caption, 0-200 characters
@@ -137,7 +138,7 @@ public:
const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const;
/**
- * Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Document).
+ * @brief Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message. For this to work, your audio must be in an .ogg file encoded with OPUS (other formats may be sent as Document).
* @param chatId Unique identifier for the target chat.
* @param audio Id of the audio that is already on the Telegram servers.
* @param caption Audio caption, 0-200 characters
@@ -155,7 +156,7 @@ public:
const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const;
/**
- * Use this method to send general files.
+ * @brief Use this method to send general files.
* @param chatId Unique identifier for the target chat.
* @param document Document to send.
* @param caption Document caption (may also be used when resending documents by file_id), 0-200 characters
@@ -169,7 +170,7 @@ public:
const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const;
/**
- * Use this method to send general files.
+ * @brief Use this method to send general files.
* @param chatId Unique identifier for the target chat.
* @param document Id of the document that is already on the Telegram servers.
* @param caption Document caption (may also be used when resending documents by file_id), 0-200 characters
@@ -183,7 +184,7 @@ public:
const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const;
/**
- * Use this method to send .webp stickers.
+ * @brief Use this method to send .webp stickers.
* @param chatId Unique identifier for the target chat.
* @param sticker Sticker to send.
* @param replyToMessageId Optional. If the message is a reply, ID of the original message.
@@ -195,7 +196,7 @@ public:
const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), bool disableNotification = false) const;
/**
- * Use this method to send .webp stickers.
+ * @brief Use this method to send .webp stickers.
* @param chatId Unique identifier for the target chat.
* @param stickerId Id of the sticker that is already on the Telegram servers.
* @param replyToMessageId Optional. If the message is a reply, ID of the original message.
@@ -207,14 +208,14 @@ public:
const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), bool disableNotification = false) const;
/**
- * Use this method to get a sticker set.
+ * @brief Use this method to get a sticker set.
* @param chatId Name of the sticker set.
* @return On success, a StickerSet object is returned.
*/
StickerSet::Ptr getStickerSet(const std::string& name) const;
/**
- * Use this method to upload a .png file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times).
+ * @brief Use this method to upload a .png file with a sticker for later use in createNewStickerSet and addStickerToSet methods (can be used multiple times).
* @param userId User identifier of sticker file owner.
* @param pngSticker Png image with the sticker, must be up to 512 kilobytes in size, dimensions must not exceed 512px, and either width or height must be exactly 512px.
* @return Returns the uploaded File on success.
@@ -222,7 +223,7 @@ public:
File::Ptr uploadStickerFile(int32_t userId, const InputFile::Ptr pngSticker) const;
/**
- * Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set.
+ * @brief Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set.
* @param userId User identifier of created sticker set owner.
* @param name Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in “_by_<bot username>”. <bot_username> is case insensitive. 1-64 characters.
* @param title Sticker set title, 1-64 characters.
@@ -236,7 +237,7 @@ public:
InputFile::Ptr pngSticker, const std::string& emojis, bool containsMasks = false, MaskPosition::Ptr maskPosition = nullptr) const;
/**
- * Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set.
+ * @brief Use this method to create new sticker set owned by a user. The bot will be able to edit the created sticker set.
* @param userId User identifier of created sticker set owner.
* @param name Short name of sticker set, to be used in t.me/addstickers/ URLs (e.g., animals). Can contain only english letters, digits and underscores. Must begin with a letter, can't contain consecutive underscores and must end in “_by_<bot username>”. <bot_username> is case insensitive. 1-64 characters.
* @param title Sticker set title, 1-64 characters.
@@ -250,7 +251,7 @@ public:
const std::string& pngSticker, const std::string& emojis, bool containsMasks = false, MaskPosition::Ptr maskPosition = nullptr) const;
/**
- * Use this method to add a new sticker to a set created by the bot.
+ * @brief Use this method to add a new sticker to a set created by the bot.
* @param userId User identifier of created sticker set owner.
* @param name Sticker set name.
* @param title Sticker set title, 1-64 characters.
@@ -263,7 +264,7 @@ public:
InputFile::Ptr pngSticker, const std::string& emojis, MaskPosition::Ptr maskPosition = nullptr) const;
/**
- * Use this method to add a new sticker to a set created by the bot.
+ * @brief Use this method to add a new sticker to a set created by the bot.
* @param userId User identifier of created sticker set owner.
* @param name Sticker set name.
* @param title Sticker set title, 1-64 characters.
@@ -276,7 +277,7 @@ public:
const std::string& pngSticker, const std::string& emojis, MaskPosition::Ptr maskPosition = nullptr) const;
/**
- * Use this method to move a sticker in a set created by the bot to a specific position.
+ * @brief Use this method to move a sticker in a set created by the bot to a specific position.
* @param stickers File identifier of the sticker.
* @param position New sticker position in the set, zero-based.
* @return Returns True on success.
@@ -284,14 +285,14 @@ public:
bool setStickerPositionInSet(const std::string& sticker, uint32_t position) const;
/**
- * Use this method to delete a sticker from a set created by the bot.
+ * @brief Use this method to delete a sticker from a set created by the bot.
* @param stickers File identifier of the sticker.
* @return Returns True on success.
*/
bool deleteStickerPositionInSet(const std::string& sticker) const;
/**
- * Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document).
+ * @brief Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document).
* @param chatId Unique identifier for the target chat.
* @param video Video to send.
* @param supportsStreaming Optional. Pass True, if the uploaded video is suitable for streaming.
@@ -309,7 +310,7 @@ public:
int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const;
/**
- * Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document).
+ * @brief Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document).
* @param chatId Unique identifier for the target chat.
* @param videoId Id of the video that is already on the Telegram servers.
* @param supportsStreaming Optional. Pass True, if the uploaded video is suitable for streaming.
@@ -327,7 +328,7 @@ public:
int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const;
/**
- * Use this method to send video messages. On success, the sent Message is returned.
+ * @brief Use this method to send video messages. On success, the sent Message is returned.
* @param chatId Unique identifier for the target chat.
* @param videoNote Video note to send.
* @param replyToMessageId If the message is a reply, ID of the original message.
@@ -341,7 +342,7 @@ public:
int32_t duration = 0, int32_t length = 0, const GenericReply::Ptr replyMarkup = GenericReply::Ptr());
/**
- * Use this method to send video messages. On success, the sent Message is returned.
+ * @brief Use this method to send video messages. On success, the sent Message is returned.
* @param chatId Unique identifier for the target chat.
* @param videoNote Id of the video note that exists on the Telegram servers.
* @param replyToMessageId If the message is a reply, ID of the original message.
@@ -355,7 +356,7 @@ public:
int32_t duration = 0, int32_t length = 0, const GenericReply::Ptr replyMarkup = GenericReply::Ptr());
/**
- * Use this method to send a group of photos or videos as an album.
+ * @brief Use this method to send a group of photos or videos as an album.
* @param chatId Unique identifier for the target chat of the target channel.
* @param media A JSON-serialized array describing photos and videos to be sent, must include 2–10 items.
* @param disableNotification Optional. Sends the messages silently. Users will receive a notification with no sound.
@@ -366,7 +367,7 @@ public:
bool disableNotification = false, int32_t replyToMessageId = 0) const;
/**
- * Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message.
+ * @brief Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message.
* @param chatId Unique identifier for the target chat.
* @param voice Audio file to send.
* @param caption Voice message caption, 0-200 characters
@@ -381,7 +382,7 @@ public:
const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const;
/**
- * Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message.
+ * @brief Use this method to send audio files, if you want Telegram clients to display the file as a playable voice message.
* @param chatId Unique identifier for the target chat.
* @param voiceId Id of the voice that is already on the Telegram servers.
* @param caption Voice message caption, 0-200 characters
@@ -396,7 +397,7 @@ public:
const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), const std::string& parseMode = "", bool disableNotification = false) const;
/**
- * Use this method to send point on the map.
+ * @brief Use this method to send point on the map.
* @param chatId Unique identifier for the target chat.
* @param latitude Latitude of location.
* @param longitude Longitude of location.
@@ -410,7 +411,7 @@ public:
int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>(), bool disableNotification = false) const;
/**
- * Use this method to edit live location messages sent by the bot or via the bot (for inline bots).
+ * @brief Use this method to edit live location messages sent by the bot or via the bot (for inline bots).
* @param latitude Latitude of new location.
* @param longitude Longitude of new location.
* @param chatId Optional. Required if inlineMessageId is not specified. Unique identifier for the target chat of the target channel.
@@ -423,7 +424,7 @@ public:
int32_t inlineMessageId = 0, const InlineKeyboardMarkup::Ptr replyMarkup = std::make_shared<InlineKeyboardMarkup>()) const;
/**
- * Use this method to edit live location messages sent by the bot or via the bot (for inline bots).
+ * @brief Use this method to edit live location messages sent by the bot or via the bot (for inline bots).
* @param chatId Optional. Required if inlineMessageId is not specified. Unique identifier for the target chat of the target channel.
* @param messageId Optional. Required if inlineMessageId is not specified. Identifier of the sent message.
* @param inlineMessageId Optional. Required if chatId and messageId are not specified. Identifier of the inline message.
@@ -435,7 +436,7 @@ public:
/**
- * Use this method to send information about a venue. On success, the sent Message is returned.
+ * @brief Use this method to send information about a venue. On success, the sent Message is returned.
* @param chatId Unique identifier for the target chat.
* @param latitude Latitude of location.
* @param longitude Longitude of location.
@@ -451,7 +452,7 @@ public:
bool disableNotification = false, int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const;
/**
- * Use this method to send phone contacts. On success, the sent Message is returned.
+ * @brief Use this method to send phone contacts. On success, the sent Message is returned.
* @param chatId Unique identifier for the target chat.
* @param phoneNumber Contact's phone number.
* @param firstName Contact's first name.
@@ -465,16 +466,18 @@ public:
int32_t replyToMessageId = 0, const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const;
/**
- * Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status).
+ * @brief Use this method when you need to tell the user that something is happening on the bot's side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status).
+ *
* Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of “Retrieving image, please wait…”, the bot may use sendChatAction with action = upload_photo. The user will see a “sending photo” status for the bot.
* We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.
+ *
* @param chatId Unique identifier for the target chat.
* @param action Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_audio or upload_audio for audio files, upload_document for general files, find_location for location data.
*/
void sendChatAction(int64_t chatId, const std::string& action) const;
/**
- * Use this method to get a list of profile pictures for a user.
+ * @brief Use this method to get a list of profile pictures for a user.
* @param userId Unique identifier of the target user.
* @param offset Optional. Sequential number of the first photo to be returned. By default, all photos are returned.
* @param limit Optional. Limits the number of photos to be retrieved. Values between 1—100 are accepted. Defaults to 100.
@@ -483,42 +486,42 @@ public:
UserProfilePhotos::Ptr getUserProfilePhotos(int32_t userId, int32_t offset = 0, int32_t limit = 100) const;
/**
- * Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size.
+ * @brief Use this method to get basic info about a file and prepare it for downloading. For the moment, bots can download files of up to 20MB in size.
* @param fileId File identifier to get info about
* @return A File object.
*/
File::Ptr getFile(const std::string &fileId) const;
/**
- * Use this method for your bot to leave a group, supergroup or channel.
+ * @brief Use this method for your bot to leave a group, supergroup or channel.
* @param chatId Unique identifier for the target chat of the target supergroup or channel.
* @return True on success
*/
bool leaveChat(int64_t chatId) const;
/**
- * Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.
+ * @brief Use this method to get up to date information about the chat (current name of the user for one-on-one conversations, current username of a user, group or channel, etc.). Returns a Chat object on success.
* @param chatId Unique identifier for the target chat of the target supergroup or channel.
* @return Chat object.
*/
Chat::Ptr getChat(int64_t chatId) const;
/**
- * Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.
+ * @brief Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.
* @param chatId Unique identifier for the target chat of the target supergroup or channel.
* @return ChatMember object.
*/
std::vector<ChatMember::Ptr> getChatAdministrators(int64_t chatId) const;
/**
- * Use this method to get the number of members in a chat. Returns Int on success.
+ * @brief Use this method to get the number of members in a chat. Returns Int on success.
* @param chatId Unique identifier for the target chat of the target supergroup or channel.
* @return Int.
*/
int32_t getChatMembersCount(int64_t chatId) const;
/**
- * Use this method to get information about a member of a chat. Returns a ChatMember object on success.
+ * @brief Use this method to get information about a member of a chat. Returns a ChatMember object on success.
* @param chatId Unique identifier for the target chat of the target supergroup or channel.
* @param userId Unique identifier of the target user
* @return ChatMember object.
@@ -526,7 +529,7 @@ public:
ChatMember::Ptr getChatMember(int64_t chatId, int32_t userId) const;
/**
- * Use this method to get information about a member of a chat. Returns a ChatMember object on success.
+ * @brief Use this method to get information about a member of a chat. Returns a ChatMember object on success.
* @param chatId Unique identifier for the target chat of the target supergroup or channel.
* @param stickerSetName Name of the sticker set to be set as the group sticker set.
* @return Returns True on success.
@@ -534,7 +537,7 @@ public:
bool setChatStickerSet(int64_t chatId, const std::string& stickerSetName) const;
/**
- * Use this method to get information about a member of a chat. Returns a ChatMember object on success.
+ * @brief Use this method to get information about a member of a chat. Returns a ChatMember object on success.
* @param chatId Unique identifier for the target chat of the target supergroup or channel.
* @return Returns True on success.
*/
@@ -542,7 +545,7 @@ public:
/**
- * Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert.
+ * @brief Use this method to send answers to callback queries sent from inline keyboards. The answer will be displayed to the user as a notification at the top of the chat screen or as an alert.
* @param callbackQueryId Unique identifier for the query to be answered
* @param text Optional Text of the notification. If not specified, nothing will be shown to the user, 0-200 characters
* @param showAlert Optional If true, an alert will be shown by the client instead of a notification at the top of the chat screen. Defaults to false.
@@ -553,7 +556,7 @@ public:
bool answerCallbackQuery(const std::string & callbackQueryId, const std::string & text="", bool showAlert=false, const std::string &url="", int32_t cacheTime=0) const;
/**
- * Use this method to edit text and game messages sent by the bot or via the bot (for inline bots)
+ * @brief Use this method to edit text and game messages sent by the bot or via the bot (for inline bots)
* @param text New text of the message
* @param chatId Optional Required if inline_message_id is not specified. Unique identifier for the target chat of the target channel.
* @param messageId Optional Required if inline_message_id is not specified. Identifier of the sent message
@@ -567,7 +570,7 @@ public:
const std::string& parseMode = "", bool disableWebPagePreview = false, const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const;
/**
- * Use this method to edit captions of messages sent by the bot or via the bot (for inline bots).
+ * @brief Use this method to edit captions of messages sent by the bot or via the bot (for inline bots).
* @param chatId Optional Required if inline_message_id is not specified. Unique identifier for the target chat of the target channel.
* @param messageId Optional Required if inline_message_id is not specified. Identifier of the sent message
* @param caption Optional New caption of the message
@@ -579,7 +582,7 @@ public:
const std::string& inlineMessageId = "", const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const;
/**
- * Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots).
+ * @brief Use this method to edit only the reply markup of messages sent by the bot or via the bot (for inline bots).
* @param chatId Optional Required if inline_message_id is not specified. Unique identifier for the target chat of the target channel.
* @param messageId Optional Required if inline_message_id is not specified. Identifier of the sent message
* @param inlineMessageId Optional Required if chat_id and message_id are not specified. Identifier of the inline message
@@ -590,16 +593,18 @@ public:
const GenericReply::Ptr replyMarkup = std::make_shared<GenericReply>()) const;
/**
- * Use this method to delete messages sent by bot (or by other users if bot is admin).
+ * @brief Use this method to delete messages sent by bot (or by other users if bot is admin).
* @param chatId Unique identifier for the target chat.
* @param messageId Unique identifier for the target message.
*/
void deleteMessage(int64_t chatId, int32_t messageId) const;
/**
- * Use this method to receive incoming updates using long polling.
+ * @brief Use this method to receive incoming updates using long polling.
+ *
* This method will not work if an outgoing webhook is set up.
* In order to avoid getting duplicate updates, recalculate offset after each server response.
+ *
* @param offset Optional. Identifier of the first update to be returned. Must be greater by one than the highest among the identifiers of previously received updates. By default, updates starting with the earliest unconfirmed update are returned. An update is considered confirmed as soon as getUpdates is called with an offset higher than its update_id.
* @param limit Optional. Limits the number of updates to be retrieved. Values between 1—100 are accepted. Defaults to 100.
* @param timeout Optional. Timeout in seconds for long polling. Defaults to 0, i.e. usual short polling.
@@ -609,30 +614,38 @@ public:
std::vector<Update::Ptr> getUpdates(int32_t offset = 0, int32_t limit = 100, int32_t timeout = 0, const StringArrayPtr &allowedUpdates = nullptr) const;
/**
- * Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts.
+ * @brief Use this method to specify a url and receive incoming updates via an outgoing webhook. Whenever there is an update for the bot, we will send an HTTPS POST request to the specified url, containing a JSON-serialized Update. In case of an unsuccessful request, we will give up after a reasonable amount of attempts.
+ *
* If you'd like to make sure that the Webhook request comes from Telegram, we recommend using a secret path in the URL, e.g. www.example.com/<token>. Since nobody else knows your bot‘s token, you can be pretty sure it’s us.
* You will not be able to receive updates using getUpdates for as long as an outgoing webhook is set up.
* We currently do not support self-signed certificates.
* Ports currently supported for Webhooks: 443, 80, 88, 8443.
+ *
* @param url Optional. HTTPS url to send updates to. Use an empty string to remove webhook integration.
*/
void setWebhook(const std::string& url = "", const InputFile::Ptr certificate = nullptr, int32_t maxConnection = 40, const StringArrayPtr &allowedUpdates = nullptr) const;
/**
- * Use this method to remove webhook integration if you decide to switch back to getUpdates.
- * Returns True on success. Requires no parameters.
+ * @brief Use this method to remove webhook integration if you decide to switch back to getUpdates.
+ *
+ * Requires no parameters.
+ *
+ * @return Returns True on success.
*/
bool deleteWebhook() const;
/**
- * Use this method to get current webhook status.
- * Requires no parameters. On success, returns a WebhookInfo object.
+ * @brief Use this method to get current webhook status.
+ *
+ * Requires no parameters.
* If the bot is using getUpdates, will return an object with the url field empty.
+ *
+ * @return On success, returns a WebhookInfo object.
*/
WebhookInfo::Ptr getWebhookInfo() const;
/**
- * Use this method to send answers to an inline query.
+ * @brief Use this method to send answers to an inline query.
* No mode that 50 results per query are allowed.
* @param inlineQueryId Unique identifier for the answered query.
* @param results Array of results for the inline query.
@@ -647,7 +660,7 @@ public:
int32_t cacheTime = 300, bool isPersonal = false, const std::string& nextOffset = "", const std::string& switchPmText = "", const std::string& switchPmParameter = "") const;
/**
- * Use this method to kick a user from a group or a supergroup.
+ * @brief Use this method to kick a user from a group or a supergroup.
* @param chatId Unique identifier for the target group.
* @param userId Unique identifier of the target user.
* @param untilDate Optional. Date when the user will be unbanned, unix time. If user is banned for more than 366 days or less than 30 seconds from the current time they are considered to be banned forever.
@@ -656,7 +669,7 @@ public:
bool kickChatMember(int64_t chatId, int32_t userId, uint64_t untilDate = 0) const;
/**
- * Use this method to unban a previously kicked user in a supergroup.
+ * @brief Use this method to unban a previously kicked user in a supergroup.
* @param chatId Unique identifier for the target group.
* @param userId Unique identifier of the target user.
* @return True on success
@@ -664,7 +677,7 @@ public:
bool unbanChatMember(int64_t chatId, int32_t userId) const;
/**
- * Use this method to restrict a user in a supergroup.
+ * @brief Use this method to restrict a user in a supergroup.
* @param chatId Unique identifier for the target chat of the target supergroup.
* @param userId Unique identifier of the target user.
* @param untilDate Optional. Date when restrictions will be lifted for the user, unix time. If user is restricted for more than 366 days or less than 30 seconds from the current time, they are considered to be restricted forever.
@@ -678,7 +691,7 @@ public:
bool canSendMediaMessages = false, bool canSendOtherMessages = false, bool canAddWebPagePreviews = false) const;
/**
- * Use this method to promote or demote a user in a supergroup or a channel.
+ * @brief Use this method to promote or demote a user in a supergroup or a channel.
* @param chatId Unique identifier for the target chat of the target supergroup or channal.
* @param userId Unique identifier of the target user.
* @param canChangeInfo Optional. Pass True, if the administrator can change chat title, photo and other settings.
@@ -695,15 +708,17 @@ public:
bool canEditMessages = false, bool canDeleteMessages = false, bool canInviteUsers = false, bool canPinMessages = false, bool canPromoteMembers = false) const;
/**
- * Use this method to generate a new invite link for a chat; any previously generated link is revoked.
+ * @brief Use this method to generate a new invite link for a chat; any previously generated link is revoked.
* @param chatId Unique identifier for the target chat.
* @return The new invite link as String on success.
*/
std::string exportChatInviteLink(int64_t chatId) const;
/**
- * Use this method to set a new profile photo for the chat.
+ * @brief Use this method to set a new profile photo for the chat.
+ *
* Photos can't be changed for private chats.
+ *
* @param chatId Unique identifier for the target chat.
* @param photo New chat photo.
* @return True on success
@@ -711,16 +726,20 @@ public:
bool setChatPhoto(int64_t chatId, const InputFile::Ptr photo) const;
/**
- * Use this method to delete a chat photo.
+ * @brief Use this method to delete a chat photo.
+ *
* Photos can't be changed for private chats.
+ *
* @param chatId Unique identifier for the target chat.
* @return True on success
*/
bool deleteChatPhoto(int64_t chatId) const;
/**
- * Use this method to change the title of a chat.
+ * @brief Use this method to change the title of a chat.
+ *
* Titles can't be changed for private chats.
+ *
* @param chatId Unique identifier for the target chat.
* @param title New chat title, 1-255 characters.
* @return True on success
@@ -728,7 +747,7 @@ public:
bool setChatTitle(int64_t chatId, const std::string& title) const;
/**
- * Use this method to change the description of a supergroup or a channel.
+ * @brief Use this method to change the description of a supergroup or a channel.
* @param chatId Unique identifier for the target chat.
* @param description New chat description, 1-255 characters.
* @return True on success
@@ -736,7 +755,7 @@ public:
bool setChatDescription(int64_t chatId, const std::string& description) const;
/**
- * Use this method to pin a message in a supergroup or a channel.
+ * @brief Use this method to pin a message in a supergroup or a channel.
* @param chatId Unique identifier for the target chat.
* @param messageId Identifier of a message to pin.
* @param disableNotification Optional. Pass True, if it is not necessary to send a notification to all chat members about the new pinned message. Notifications are always disabled in channels.
@@ -745,7 +764,7 @@ public:
bool pinChatMessage(int64_t chatId, int32_t messageId, bool disableNotification = false) const;
/**
- * Use this method to unpin a message in a supergroup or a channel.
+ * @brief Use this method to unpin a message in a supergroup or a channel.
* @param chatId Unique identifier for the target chat.
* @return True on success
*/
@@ -753,7 +772,7 @@ public:
/**
- * Downloads file from Telegram and saves it in memory.
+ * @brief Downloads file from Telegram and saves it in memory.
* @param filePath Telegram file path.
* @param args Additional api parameters.
* @return File contents in a string.
diff --git a/include/tgbot/Bot.h b/include/tgbot/Bot.h
index 36e723b..8dd4c16 100644
--- a/include/tgbot/Bot.h
+++ b/include/tgbot/Bot.h
@@ -32,7 +32,8 @@
namespace TgBot {
/**
- * This object holds other objects specific for this bot instance.
+ * @brief This object holds other objects specific for this bot instance.
+ *
* @ingroup general
*/
class Bot {
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){
diff --git a/include/tgbot/TgException.h b/include/tgbot/TgException.h
index 1a3e172..4b03e1c 100644
--- a/include/tgbot/TgException.h
+++ b/include/tgbot/TgException.h
@@ -29,7 +29,8 @@
namespace TgBot {
/**
- * Exception type which is only thrown when Telegram refuses API request.
+ * @brief Exception type which is only thrown when Telegram refuses API request.
+ *
* @ingroup general
*/
class TgException : public std::runtime_error {
diff --git a/include/tgbot/net/HttpClient.h b/include/tgbot/net/HttpClient.h
index e695398..8d67891 100644
--- a/include/tgbot/net/HttpClient.h
+++ b/include/tgbot/net/HttpClient.h
@@ -34,19 +34,21 @@
namespace TgBot {
/**
- * This class makes http requests.
+ * @brief This class makes http requests.
+ *
* @ingroup net
*/
class HttpClient {
public:
/**
- * Returns instance which lives during all application lifetime.
+ * @brief Returns instance which lives during all application lifetime.
*/
static HttpClient& getInstance();
/**
- * Sends a request to the url.
+ * @brief Sends a request to the url.
+ *
* If there's no args specified, a GET request will be sent, otherwise a POST request will be sent.
* If at least 1 arg is marked as file, the content type of a request will be multipart/form-data, otherwise it will be application/x-www-form-urlencoded.
*/
diff --git a/include/tgbot/net/HttpReqArg.h b/include/tgbot/net/HttpReqArg.h
index 5aa60fd..7476366 100644
--- a/include/tgbot/net/HttpReqArg.h
+++ b/include/tgbot/net/HttpReqArg.h
@@ -32,7 +32,8 @@
namespace TgBot {
/**
- * This class represents argument in POST http requests.
+ * @brief This class represents argument in POST http requests.
+ *
* @ingroup net
*/
class HttpReqArg {
@@ -45,27 +46,27 @@ public:
}
/**
- * Name of an argument.
+ * @brief Name of an argument.
*/
std::string name;
/**
- * Value of an argument.
+ * @brief Value of an argument.
*/
std::string value;
/**
- * Should be true if an argument value hold some file contents
+ * @brief Should be true if an argument value hold some file contents
*/
bool isFile = false;
/**
- * Mime type of an argument value. This field makes sense only if isFile is true.
+ * @brief Mime type of an argument value. This field makes sense only if isFile is true.
*/
std::string mimeType = "text/plain";
/**
- * Should be set if an argument value hold some file contents
+ * @brief Should be set if an argument value hold some file contents
*/
std::string fileName;
};
diff --git a/include/tgbot/net/HttpServer.h b/include/tgbot/net/HttpServer.h
index d68599f..e760e29 100644
--- a/include/tgbot/net/HttpServer.h
+++ b/include/tgbot/net/HttpServer.h
@@ -32,7 +32,8 @@
namespace TgBot {
/**
- * This class handles HTTP requests from the Internet.
+ * @brief This class handles HTTP requests from the Internet.
+ *
* @ingroup net
*/
template<typename Protocol>
@@ -48,7 +49,7 @@ public:
}
/**
- * Starts receiving new connections.
+ * @brief Starts receiving new connections.
*/
void start() {
auto socket(std::make_shared<boost::asio::basic_stream_socket<Protocol>>(_acceptor->get_io_service()));
@@ -61,7 +62,7 @@ public:
}
/**
- * Stops receiving new connections.
+ * @brief Stops receiving new connections.
*/
void stop() {
_ioService.stop();
diff --git a/include/tgbot/net/TgLongPoll.h b/include/tgbot/net/TgLongPoll.h
index 93ace5b..e2d0b94 100644
--- a/include/tgbot/net/TgLongPoll.h
+++ b/include/tgbot/net/TgLongPoll.h
@@ -30,7 +30,8 @@
namespace TgBot {
/**
- * This class handles long polling and updates parsing.
+ * @brief This class handles long polling and updates parsing.
+ *
* @ingroup net
*/
class TgLongPoll {
@@ -40,7 +41,7 @@ public:
TgLongPoll(const Bot& bot, int32_t = 100, int32_t = 60, const std::shared_ptr<std::vector<std::string>>& = nullptr);
/**
- * Starts long poll. After new update will come, this method will parse it and send to EventHandler which invokes your listeners. Designed to be executed in a loop.
+ * @brief Starts long poll. After new update will come, this method will parse it and send to EventHandler which invokes your listeners. Designed to be executed in a loop.
*/
void start();
diff --git a/include/tgbot/net/TgWebhookLocalServer.h b/include/tgbot/net/TgWebhookLocalServer.h
index 99a0fba..685979d 100644
--- a/include/tgbot/net/TgWebhookLocalServer.h
+++ b/include/tgbot/net/TgWebhookLocalServer.h
@@ -30,7 +30,8 @@
namespace TgBot {
/**
- * This class setups HTTP server for receiving Telegram Update objects from unix socket.
+ * @brief This class setups HTTP server for receiving Telegram Update objects from unix socket.
+ *
* @ingroup net
*/
class TgWebhookLocalServer : public TgWebhookServer<boost::asio::local::stream_protocol> {
diff --git a/include/tgbot/net/Url.h b/include/tgbot/net/Url.h
index 56f502a..c039355 100644
--- a/include/tgbot/net/Url.h
+++ b/include/tgbot/net/Url.h
@@ -28,7 +28,8 @@
namespace TgBot {
/**
- * This class parses a string with the url
+ * @brief This class parses a string with the url
+ *
* @ingroup net
*/
class Url {
@@ -37,27 +38,27 @@ public:
Url(const std::string& url);
/**
- * Protocol part of an url. Example: https://
+ * @brief Protocol part of an url. Example: https://
*/
std::string protocol;
/**
- * Host part of an url. Example: www.example.com
+ * @brief Host part of an url. Example: www.example.com
*/
std::string host;
/**
- * Path part of an url including preceding '/' char. Example: /index.html
+ * @brief Path part of an url including preceding '/' char. Example: /index.html
*/
std::string path;
/**
- * Query part of an url without '?' char. Example: a=1&b=2&c=3
+ * @brief Query part of an url without '?' char. Example: a=1&b=2&c=3
*/
std::string query;
/**
- * Fragment part of an url without '#' char. Example: section1
+ * @brief Fragment part of an url without '#' char. Example: section1
*/
std::string fragment;
};
diff --git a/include/tgbot/types/Audio.h b/include/tgbot/types/Audio.h
index 14cf17f..e640bce 100644
--- a/include/tgbot/types/Audio.h
+++ b/include/tgbot/types/Audio.h
@@ -29,7 +29,8 @@
namespace TgBot {
/**
- * This object represents an audio file (voice note).
+ * @brief This object represents an audio file (voice note).
+ *
* @ingroup types
*/
class Audio {
@@ -38,34 +39,34 @@ public:
typedef std::shared_ptr<Audio> Ptr;
/**
- * Unique identifier for this file.
+ * @brief Unique identifier for this file.
*/
std::string fileId;
/**
- * Duration of the audio in seconds as defined by sender.
+ * @brief Duration of the audio in seconds as defined by sender.
*/
int32_t duration;
/**
- * Optional. Performer of the audio as defined by sender
+ * @brief Optional. Performer of the audio as defined by sender
* or by audio tags
*/
std::string performer;
/**
- * Optional. Title of the audio as defined by sender or
+ * @brief Optional. Title of the audio as defined by sender or
* by audio tags
*/
std::string title;
/**
- * Optional. MIME type of the file as defined by sender.
+ * @brief Optional. MIME type of the file as defined by sender.
*/
std::string mimeType;
/**
- * Optional. File size.
+ * @brief Optional. File size.
*/
int32_t fileSize;
};
diff --git a/include/tgbot/types/CallbackQuery.h b/include/tgbot/types/CallbackQuery.h
index 8d684c0..4ee4538 100644
--- a/include/tgbot/types/CallbackQuery.h
+++ b/include/tgbot/types/CallbackQuery.h
@@ -14,7 +14,7 @@
namespace TgBot {
/**
- * This object represents an incoming callback query from a callback button in an inline keyboard.
+ * @brief This object represents an incoming callback query from a callback button in an inline keyboard.
* @ingroup types
*/
class CallbackQuery {
@@ -22,37 +22,37 @@ public:
typedef std::shared_ptr<CallbackQuery> Ptr;
/**
- * Unique identifier for this query.
+ * @brief Unique identifier for this query.
*/
std::string id;
/**
- * Sender.
+ * @brief Sender.
*/
User::Ptr from;
/**
- * Optional. Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old.
+ * @brief Optional. Message with the callback button that originated the query. Note that message content and message date will not be available if the message is too old.
*/
Message::Ptr message;
/**
- * Optional. Identifier of the message sent via the bot in inline mode, that originated the query.
+ * @brief Optional. Identifier of the message sent via the bot in inline mode, that originated the query.
*/
std::string inlineMessageId;
/**
- * Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.
+ * @brief Global identifier, uniquely corresponding to the chat to which the message with the callback button was sent. Useful for high scores in games.
*/
std::string chatInstance;
/**
- * Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field.
+ * @brief Data associated with the callback button. Be aware that a bad client can send arbitrary data in this field.
*/
std::string data;
/*
- * Optional. Short name of a Game to be returned, serves as the unique identifier for the game
+ * @brief Optional. Short name of a Game to be returned, serves as the unique identifier for the game
*/
std::string gameShortName;
};
diff --git a/include/tgbot/types/Chat.h b/include/tgbot/types/Chat.h
index 978d2c4..37e1cd0 100644
--- a/include/tgbot/types/Chat.h
+++ b/include/tgbot/types/Chat.h
@@ -32,7 +32,7 @@ namespace TgBot {
class Message;
/**
- * This object represents a Telegram Chat
+ * @brief This object represents a Telegram Chat
* @ingroup types
*/
class Chat {
@@ -41,83 +41,83 @@ public:
typedef std::shared_ptr<Chat> Ptr;
/**
- * Enum of possible types of a chat.
+ * @brief Enum of possible types of a chat.
*/
enum class Type {
Private, Group, Supergroup, Channel
};
/**
- * Unique identifier for this chat, not exceeding 1e13 by absolute value
+ * @brief Unique identifier for this chat, not exceeding 1e13 by absolute value
*/
int64_t id;
/**
- * Type of chat: can be either "private", "group", "supergroup, or "channel".
+ * @brief Type of chat: can be either "private", "group", "supergroup, or "channel".
*/
Type type;
/**
- * Optional. Title for channels and group chat
+ * @brief Optional. Title for channels and group chat
*/
std::string title;
/**
- * Optional. Username for
+ * @brief Optional. Username for
* private chats and channels
*/
std::string username;
/**
- * Optional. First name of the
+ * @brief Optional. First name of the
* other party in private chat
*/
std::string firstName;
/**
- * Optional. Last name of the
+ * @brief Optional. Last name of the
* other party in private chat
*/
std::string lastName;
/**
- * Optional. True if a group
+ * @brief Optional. True if a group
* has ‘All Members Are Admins’ enabled.
*/
bool allMembersAreAdministrators;
/**
- * Optional. Chat photo.
+ * @brief Optional. Chat photo.
* Returned only in getChat.
*/
ChatPhoto::Ptr photo;
/**
- * Optional. Description, for supergroups and channel chats.
+ * @brief Optional. Description, for supergroups and channel chats.
* Returned only in getChat.
*/
std::string description;
/**
- * Optional. Chat invite link, for supergroups and channel chats.
+ * @brief Optional. Chat invite link, for supergroups and channel chats.
* Returned only in getChat.
*/
std::string inviteLink;
/**
- * Optional. Pinned message, for supergroups and channel chats.
+ * @brief Optional. Pinned message, for supergroups and channel chats.
* Returned only in getChat.
*/
std::shared_ptr<Message> pinnedMessage;
/**
- * Optional. For supergroups, name of group sticker set.
+ * @brief Optional. For supergroups, name of group sticker set.
* Returned only in getChat.
*/
std::string stickerSetName;
/**
- * Optional. True, if the bot can change the group sticker set.
+ * @brief Optional. True, if the bot can change the group sticker set.
* Returned only in getChat.
*/
bool canSetStickerSet;
diff --git a/include/tgbot/types/ChatMember.h b/include/tgbot/types/ChatMember.h
index a77e23a..cc16ae2 100644
--- a/include/tgbot/types/ChatMember.h
+++ b/include/tgbot/types/ChatMember.h
@@ -14,7 +14,7 @@
namespace TgBot {
/**
- * This object contains information about one member of the chat.
+ * @brief This object contains information about one member of the chat.
* @ingroup types
*/
class ChatMember {
@@ -22,82 +22,82 @@ public:
typedef std::shared_ptr<ChatMember> Ptr;
/**
- * Information about the user
+ * @brief Information about the user
*/
User::Ptr user;
/**
- * The member's status in the chat. Can be “creator”, “administrator”, “member”, “restricted”, “left” or “kicked”
+ * @brief The member's status in the chat. Can be “creator”, “administrator”, “member”, “restricted”, “left” or “kicked”
*/
std::string status;
/**
- * Optional. Restricted and kicked only. Date when restrictions will be lifted for this user, unix time.
+ * @brief Optional. Restricted and kicked only. Date when restrictions will be lifted for this user, unix time.
*/
uint64_t untilDate;
/**
- * Optional. Administrators only. True, if the bot is allowed to edit administrator privileges of that user.
+ * @brief Optional. Administrators only. True, if the bot is allowed to edit administrator privileges of that user.
*/
bool canBeEdited = false;
/**
- * Optional. Administrators only. True, if the administrator can change the chat title, photo and other settings.
+ * @brief Optional. Administrators only. True, if the administrator can change the chat title, photo and other settings.
*/
bool canChangeInfo = false;
/**
- * Optional. Administrators only. True, if the administrator can post in the channel, channels only.
+ * @brief Optional. Administrators only. True, if the administrator can post in the channel, channels only.
*/
bool canPostMessages = false;
/**
- * Optional. Administrators only. True, if the administrator can edit messages of other users and can pin messages, channels only.
+ * @brief Optional. Administrators only. True, if the administrator can edit messages of other users and can pin messages, channels only.
*/
bool canEditMessages = false;
/**
- * Optional. Administrators only. True, if the administrator can delete messages of other users.
+ * @brief Optional. Administrators only. True, if the administrator can delete messages of other users.
*/
bool canDeleteMessages = false;
/**
- * Optional. Administrators only. True, if the administrator can invite new users to the chat.
+ * @brief Optional. Administrators only. True, if the administrator can invite new users to the chat.
*/
bool canInviteUsers = false;
/**
- * Optional. Administrators only. True, if the administrator can restrict, ban or unban chat members.
+ * @brief Optional. Administrators only. True, if the administrator can restrict, ban or unban chat members.
*/
bool canRestrictMembers = false;
/**
- * Optional. Administrators only. True, if the administrator can pin messages, supergroups only.
+ * @brief Optional. Administrators only. True, if the administrator can pin messages, supergroups only.
*/
bool canPinMessages = false;
/**
- * Optional. Administrators only. True, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user).
+ * @brief Optional. Administrators only. True, if the administrator can add new administrators with a subset of his own privileges or demote administrators that he has promoted, directly or indirectly (promoted by administrators that were appointed by the user).
*/
bool canPromoteMembers = false;
/**
- * Optional. Restricted only. True, if the user can send text messages, contacts, locations and venues.
+ * @brief Optional. Restricted only. True, if the user can send text messages, contacts, locations and venues.
*/
bool canSendMessages = false;
/**
- * Optional. Restricted only. True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages.
+ * @brief Optional. Restricted only. True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages.
*/
bool canSendMediaMessages = false;
/**
- * Optional. Restricted only. True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages.
+ * @brief Optional. Restricted only. True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages.
*/
bool canSendOtherMessages = false;
/**
- * Optional. Restricted only. True, if user may add web page previews to his messages, implies can_send_media_messages.
+ * @brief Optional. Restricted only. True, if user may add web page previews to his messages, implies can_send_media_messages.
*/
bool canAddWebPagePreviews = false;
};
diff --git a/include/tgbot/types/ChatPhoto.h b/include/tgbot/types/ChatPhoto.h
index 9469d2e..a79ed3d 100644
--- a/include/tgbot/types/ChatPhoto.h
+++ b/include/tgbot/types/ChatPhoto.h
@@ -30,7 +30,7 @@
namespace TgBot {
/**
- * This object represents a chat photo.
+ * @brief This object represents a chat photo.
* @ingroup types
*/
class ChatPhoto {
@@ -38,12 +38,12 @@ public:
typedef std::shared_ptr<ChatPhoto> Ptr;
/**
- * Unique file identifier of small (160x160) chat photo. This file_id can be used only for photo download.
+ * @brief Unique file identifier of small (160x160) chat photo. This file_id can be used only for photo download.
*/
std::string smallFileId;
/**
- * Unique file identifier of big (640x640) chat photo. This file_id can be used only for photo download.
+ * @brief Unique file identifier of big (640x640) chat photo. This file_id can be used only for photo download.
*/
std::string bigFileId;
};
diff --git a/include/tgbot/types/ChosenInlineResult.h b/include/tgbot/types/ChosenInlineResult.h
index 4492e52..9808366 100644
--- a/include/tgbot/types/ChosenInlineResult.h
+++ b/include/tgbot/types/ChosenInlineResult.h
@@ -14,7 +14,8 @@
namespace TgBot {
/**
- * This object represents a result of an inline query that was chosen by the user and sent to their chat partner.
+ * @brief This object represents a result of an inline query that was chosen by the user and sent to their chat partner.
+ *
* @ingroup types
*/
class ChosenInlineResult {
@@ -22,29 +23,30 @@ public:
typedef std::shared_ptr<ChosenInlineResult> Ptr;
/**
- * The unique identifier for the result that was chosen.
+ * @brief The unique identifier for the result that was chosen.
*/
std::string resultId;
/**
- * The user that chose the result.
+ * @brief The user that chose the result.
*/
User::Ptr from;
/**
- * Optional. Sender location, only for bots that require user location
+ * @brief Optional. Sender location, only for bots that require user location
*/
Location::Ptr location;
/**
- * Optional. Identifier of the sent inline message.
+ * @brief Optional. Identifier of the sent inline message.
+ *
* Available only if there is an inline keyboard attached to the message.
* Will be also received in callback queries and can be used to edit the message.
*/
std::string inlineMessageId;
/**
- * The query that was used to obtain the result.
+ * @brief The query that was used to obtain the result.
*/
std::string query;
};
diff --git a/include/tgbot/types/Contact.h b/include/tgbot/types/Contact.h
index db2929d..3b08a15 100644
--- a/include/tgbot/types/Contact.h
+++ b/include/tgbot/types/Contact.h
@@ -29,7 +29,8 @@
namespace TgBot {
/**
- * This object represents a phone contact.
+ * @brief This object represents a phone contact.
+ *
* @ingroup types
*/
class Contact {
@@ -38,22 +39,22 @@ public:
typedef std::shared_ptr<Contact> Ptr;
/**
- * Contact's phone number.
+ * @brief Contact's phone number.
*/
std::string phoneNumber;
/**
- * Contact's first name.
+ * @brief Contact's first name.
*/
std::string firstName;
/**
- * Optional. Contact's last name.
+ * @brief Optional. Contact's last name.
*/
std::string lastName;
/**
- * Optional. Contact's user identifier in Telegram.
+ * @brief Optional. Contact's user identifier in Telegram.
*/
std::string userId;
};
diff --git a/include/tgbot/types/Document.h b/include/tgbot/types/Document.h
index 88613cb..4fb43c2 100644
--- a/include/tgbot/types/Document.h
+++ b/include/tgbot/types/Document.h
@@ -31,7 +31,8 @@
namespace TgBot {
/**
- * This object represents a general file (as opposed to photos and audio files).
+ * @brief This object represents a general file (as opposed to photos and audio files).
+ *
* @ingroup types
*/
class Document {
@@ -40,27 +41,27 @@ public:
typedef std::shared_ptr<Document> Ptr;
/**
- * Unique file identifier.
+ * @brief Unique file identifier.
*/
std::string fileId;
/**
- * Optional. Document thumbnail as defined by sender.
+ * @brief Optional. Document thumbnail as defined by sender.
*/
PhotoSize::Ptr thumb;
/**
- * Optional. Original filename as defined by sender.
+ * @brief Optional. Original filename as defined by sender.
*/
std::string fileName;
/**
- * Optional. MIME type of the file as defined by sender.
+ * @brief Optional. MIME type of the file as defined by sender.
*/
std::string mimeType;
/**
- * Optional. File size.
+ * @brief Optional. File size.
*/
int32_t fileSize;
};
diff --git a/include/tgbot/types/File.h b/include/tgbot/types/File.h
index f7c9593..8040d95 100644
--- a/include/tgbot/types/File.h
+++ b/include/tgbot/types/File.h
@@ -11,11 +11,13 @@
namespace TgBot {
/**
- * This object represents a file ready to be downloaded.
+ * @brief This object represents a file ready to be downloaded.
+ *
* The file can be downloaded via the link https://api.telegram.org/file/bot<token>/<file_path>.
* It is guaranteed that the link will be valid for at least 1 hour.
* When the link expires, a new one can be requested by calling getFile.
* Maximum file size to download is 20 MB
+ *
* @ingroup types
*/
class File {
@@ -24,17 +26,18 @@ public:
typedef std::shared_ptr<File> Ptr;
/**
- * Unique identifier for this file
+ * @brief Unique identifier for this file
*/
std::string fileId;
/**
- * Optional. File size, if known
+ * @brief Optional. File size, if known
*/
int32_t fileSize;
/**
- * Optional. File path.
+ * @brief Optional. File path.
+ *
* Use https://api.telegram.org/file/bot<token>/<file_path> to get the file.
*/
std::string filePath;
diff --git a/include/tgbot/types/ForceReply.h b/include/tgbot/types/ForceReply.h
index 8a946f8..c5c5a7b 100644
--- a/include/tgbot/types/ForceReply.h
+++ b/include/tgbot/types/ForceReply.h
@@ -30,11 +30,13 @@
namespace TgBot {
/**
- * Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.
+ * @brief Upon receiving a message with this object, Telegram clients will display a reply interface to the user (act as if the user has selected the bot‘s message and tapped ’Reply'). This can be extremely useful if you want to create user-friendly step-by-step interfaces without having to sacrifice privacy mode.
+ *
* Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). There could be two ways to create a new poll:
* Explain the user how to send a command with parameters (e.g. /newpoll question answer1 answer2). May be appealing for hardcore users but lacks modern day polish.
* Guide the user through a step-by-step process. ‘Please send me your question’, ‘Cool, now let’s add the first answer option‘, ’Great. Keep adding answer options, then send /done when you‘re ready’.
* The last option is definitely more attractive. And if you use ForceReply in your bot‘s questions, it will receive the user’s answers even if it only receives replies, commands and mentions — without any extra work for the user.
+ *
* @ingroup types
*/
class ForceReply : public GenericReply {
@@ -43,12 +45,12 @@ public:
typedef std::shared_ptr<ForceReply> Ptr;
/**
- * Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply'
+ * @brief Shows reply interface to the user, as if they manually selected the bot‘s message and tapped ’Reply'
*/
const bool forceReply = true;
/**
- * Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
+ * @brief Optional. Use this parameter if you want to force reply from specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
*/
bool selective = false;
};
diff --git a/include/tgbot/types/GenericReply.h b/include/tgbot/types/GenericReply.h
index 64e6b6c..4b20b14 100644
--- a/include/tgbot/types/GenericReply.h
+++ b/include/tgbot/types/GenericReply.h
@@ -28,7 +28,7 @@
namespace TgBot {
/**
- * This abstract class is base of all keyboard related events.
+ * @brief This abstract class is base of all keyboard related events.
* @ingroup types
*/
class GenericReply {
diff --git a/include/tgbot/types/InlineKeyboardButton.h b/include/tgbot/types/InlineKeyboardButton.h
index a8fb3db..c3da2c8 100644
--- a/include/tgbot/types/InlineKeyboardButton.h
+++ b/include/tgbot/types/InlineKeyboardButton.h
@@ -11,7 +11,8 @@
namespace TgBot {
/**
- * This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
+ * @brief This object represents one button of an inline keyboard. You must use exactly one of the optional fields.
+ *
* @ingroup types
*/
class InlineKeyboardButton {
@@ -19,27 +20,27 @@ public:
typedef std::shared_ptr<InlineKeyboardButton> Ptr;
/**
- * Label text on the button
+ * @brief Label text on the button
*/
std::string text;
/**
- * Optional. HTTP url to be opened when button is pressed.
+ * @brief Optional. HTTP url to be opened when button is pressed.
*/
std::string url;
/**
- * Optional. Data to be sent in a callback query to the bot when button is pressed.
+ * @brief Optional. Data to be sent in a callback query to the bot when button is pressed.
*/
std::string callbackData;
/**
- * Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot‘s username and the specified inline query in the input field. Can be empty, in which case just the bot’s username will be inserted.
+ * @brief Optional. If set, pressing the button will prompt the user to select one of their chats, open that chat and insert the bot‘s username and the specified inline query in the input field. Can be empty, in which case just the bot’s username will be inserted.
*/
std::string switchInlineQuery;
/**
- * Optional. If set, pressing the button will insert the bot‘s username and the specified inline query in the current chat's input field. Can be empty, in which case only the bot’s username will be inserted.
+ * @brief Optional. If set, pressing the button will insert the bot‘s username and the specified inline query in the current chat's input field. Can be empty, in which case only the bot’s username will be inserted.
*/
std::string switchInlineQueryCurrentChat;
};
diff --git a/include/tgbot/types/InlineKeyboardMarkup.h b/include/tgbot/types/InlineKeyboardMarkup.h
index 9097fa5..ef039a5 100644
--- a/include/tgbot/types/InlineKeyboardMarkup.h
+++ b/include/tgbot/types/InlineKeyboardMarkup.h
@@ -14,7 +14,8 @@
namespace TgBot {
/**
- * This object represents an inline keyboard that appears right next to the message it belongs to.
+ * @brief This object represents an inline keyboard that appears right next to the message it belongs to.
+ *
* @ingroup types
*/
class InlineKeyboardMarkup : public GenericReply {
@@ -22,7 +23,7 @@ public:
typedef std::shared_ptr<InlineKeyboardMarkup> Ptr;
/**
- * Array of button rows, each represented by an Array of InlineKeyboardButton objects.
+ * @brief Array of button rows, each represented by an Array of InlineKeyboardButton objects.
*/
std::vector<std::vector<InlineKeyboardButton::Ptr>> inlineKeyboard;
diff --git a/include/tgbot/types/InlineQuery.h b/include/tgbot/types/InlineQuery.h
index 7841f8e..b88c830 100644
--- a/include/tgbot/types/InlineQuery.h
+++ b/include/tgbot/types/InlineQuery.h
@@ -14,7 +14,8 @@
namespace TgBot {
/**
- * This object represents an incoming inline query.
+ * @brief This object represents an incoming inline query.
+ *
* @ingroup types
*/
class InlineQuery {
@@ -22,27 +23,27 @@ public:
typedef std::shared_ptr<InlineQuery> Ptr;
/**
- * Unique query identifier.
+ * @brief Unique query identifier.
*/
std::string id;
/**
- * Sender.
+ * @brief Sender.
*/
User::Ptr from;
/**
- * Optional. Sender location, only for bots that request user location
+ * @brief Optional. Sender location, only for bots that request user location
*/
Location::Ptr location;
/**
- * Text of the query.
+ * @brief Text of the query.
*/
std::string query;
/**
- * Offset of the results to be returned.
+ * @brief Offset of the results to be returned.
*/
std::string offset;
};
diff --git a/include/tgbot/types/InlineQueryResult.h b/include/tgbot/types/InlineQueryResult.h
index dc54b57..67542f2 100644
--- a/include/tgbot/types/InlineQueryResult.h
+++ b/include/tgbot/types/InlineQueryResult.h
@@ -14,7 +14,8 @@
namespace TgBot {
/**
- * This abstract class is base of all inline query results.
+ * @brief This abstract class is base of all inline query results.
+ *
* @ingroup types
*/
class InlineQueryResult {
@@ -28,32 +29,32 @@ public:
virtual ~InlineQueryResult() { }
/**
- * Type of the result.
+ * @brief Type of the result.
*/
std::string type;
/**
- * Unique identifier for this result. (1-64 bytes)
+ * @brief Unique identifier for this result. (1-64 bytes)
*/
std::string id;
/**
- * Requred, optional or missing. See description of derived classes. Title of the result.
+ * @brief Requred, optional or missing. See description of derived classes. Title of the result.
*/
std::string title;
/**
- * Optional or missing. See description of derived classes. Caption of the file to be sent, 0-200 characters
+ * @brief Optional or missing. See description of derived classes. Caption of the file to be sent, 0-200 characters
*/
std::string caption;
/**
- * Optional. Inline keyboard attached to the message
+ * @brief Optional. Inline keyboard attached to the message
*/
InlineKeyboardMarkup::Ptr replyMarkup;
/**
- * Requred, optional or missing. See description of derived classes. Content of the message to be sent
+ * @brief Requred, optional or missing. See description of derived classes. Content of the message to be sent
*/
InputMessageContent::Ptr inputMessageContent;
};
diff --git a/include/tgbot/types/InlineQueryResultArticle.h b/include/tgbot/types/InlineQueryResultArticle.h
index 18d2cc8..88d11ba 100644
--- a/include/tgbot/types/InlineQueryResultArticle.h
+++ b/include/tgbot/types/InlineQueryResultArticle.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a link to an article of web page.
+ * @brief Represents a link to an article of web page.
+ *
* @ingroup types
*/
class InlineQueryResultArticle : public InlineQueryResult {
@@ -30,32 +31,32 @@ public:
}
/**
- * Optional. URL of the result.
+ * @brief Optional. URL of the result.
*/
std::string url;
/**
- * Optional. Pass True if you don't want the URL to be shown in the message.
+ * @brief Optional. Pass True if you don't want the URL to be shown in the message.
*/
bool hideUrl;
/**
- * Optional. Short description of the result.
+ * @brief Optional. Short description of the result.
*/
std::string description;
/**
- * Optional. Url of the thumbnail for the result
+ * @brief Optional. Url of the thumbnail for the result
*/
std::string thumbUrl;
/**
- * Optional. Thumbnail width.
+ * @brief Optional. Thumbnail width.
*/
int32_t thumbWidth;
/**
- * Optinal. Thumbnail height
+ * @brief Optinal. Thumbnail height
*/
int32_t thumbHeight;
};
diff --git a/include/tgbot/types/InlineQueryResultAudio.h b/include/tgbot/types/InlineQueryResultAudio.h
index 5c3a76b..047c8af 100644
--- a/include/tgbot/types/InlineQueryResultAudio.h
+++ b/include/tgbot/types/InlineQueryResultAudio.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a link to an mp3 audio file.
+ * @brief Represents a link to an mp3 audio file.
+ *
* @ingroup types
*/
class InlineQueryResultAudio : public InlineQueryResult {
@@ -28,17 +29,17 @@ public:
}
/**
- * A valid URL for the audio file
+ * @brief A valid URL for the audio file
*/
std::string audioUrl;
/**
- * Optional. Performer
+ * @brief Optional. Performer
*/
std::string performer;
/**
- * Optional. Audio duration in seconds
+ * @brief Optional. Audio duration in seconds
*/
int32_t audioDuration;
};
diff --git a/include/tgbot/types/InlineQueryResultCachedAudio.h b/include/tgbot/types/InlineQueryResultCachedAudio.h
index bc0f382..e5299cf 100644
--- a/include/tgbot/types/InlineQueryResultCachedAudio.h
+++ b/include/tgbot/types/InlineQueryResultCachedAudio.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a link to an mp3 audio file stored on the Telegram servers.
+ * @brief Represents a link to an mp3 audio file stored on the Telegram servers.
+ *
* @ingroup types
*/
class InlineQueryResultCachedAudio : public InlineQueryResult {
@@ -27,7 +28,7 @@ public:
}
/**
- * A valid file identifier for the audio file
+ * @brief A valid file identifier for the audio file
*/
std::string audioFileId;
diff --git a/include/tgbot/types/InlineQueryResultCachedDocument.h b/include/tgbot/types/InlineQueryResultCachedDocument.h
index 796b967..da99f78 100644
--- a/include/tgbot/types/InlineQueryResultCachedDocument.h
+++ b/include/tgbot/types/InlineQueryResultCachedDocument.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a link to a file stored on the Telegram servers.
+ * @brief Represents a link to a file stored on the Telegram servers.
+ *
* @ingroup types
*/
class InlineQueryResultCachedDocument : public InlineQueryResult {
@@ -27,12 +28,12 @@ public:
}
/**
- * A valid file identifier for the file
+ * @brief A valid file identifier for the file
*/
std::string documentFileId;
/**
- * Optional. Short description of the result
+ * @brief Optional. Short description of the result
*/
std::string description;
};
diff --git a/include/tgbot/types/InlineQueryResultCachedGif.h b/include/tgbot/types/InlineQueryResultCachedGif.h
index c2599ed..17e2d46 100644
--- a/include/tgbot/types/InlineQueryResultCachedGif.h
+++ b/include/tgbot/types/InlineQueryResultCachedGif.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a link to an animated GIF file stored on the Telegram servers.
+ * @brief Represents a link to an animated GIF file stored on the Telegram servers.
+ *
* @ingroup types
*/
class InlineQueryResultCachedGif : public InlineQueryResult {
@@ -27,7 +28,7 @@ public:
}
/**
- * A valid file identifier for the GIF file
+ * @brief A valid file identifier for the GIF file
*/
std::string gifFileId;
diff --git a/include/tgbot/types/InlineQueryResultCachedMpeg4Gif.h b/include/tgbot/types/InlineQueryResultCachedMpeg4Gif.h
index b6d25e1..6c87f08 100644
--- a/include/tgbot/types/InlineQueryResultCachedMpeg4Gif.h
+++ b/include/tgbot/types/InlineQueryResultCachedMpeg4Gif.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers.
+ * @brief Represents a link to a video animation (H.264/MPEG-4 AVC video without sound) stored on the Telegram servers.
+ *
* @ingroup types
*/
class InlineQueryResultCachedMpeg4Gif : public InlineQueryResult {
@@ -27,7 +28,7 @@ public:
}
/**
- * A valid file identifier for the MP4 file
+ * @brief A valid file identifier for the MP4 file
*/
std::string mpeg4FileId;
diff --git a/include/tgbot/types/InlineQueryResultCachedPhoto.h b/include/tgbot/types/InlineQueryResultCachedPhoto.h
index 0d85dab..7cf6289 100644
--- a/include/tgbot/types/InlineQueryResultCachedPhoto.h
+++ b/include/tgbot/types/InlineQueryResultCachedPhoto.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a link to a photo stored on the Telegram servers.
+ * @brief Represents a link to a photo stored on the Telegram servers.
+ *
* @ingroup types
*/
class InlineQueryResultCachedPhoto : public InlineQueryResult {
@@ -27,12 +28,12 @@ public:
}
/**
- * A valid file identifier of the photo
+ * @brief A valid file identifier of the photo
*/
std::string photoFileId;
/**
- * Optional. Short description of the result
+ * @brief Optional. Short description of the result
*/
std::string description;
};
diff --git a/include/tgbot/types/InlineQueryResultCachedSticker.h b/include/tgbot/types/InlineQueryResultCachedSticker.h
index 84ebdac..77f66f0 100644
--- a/include/tgbot/types/InlineQueryResultCachedSticker.h
+++ b/include/tgbot/types/InlineQueryResultCachedSticker.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a link to a sticker stored on the Telegram servers.
+ * @brief Represents a link to a sticker stored on the Telegram servers.
+ *
* @ingroup types
*/
class InlineQueryResultCachedSticker : public InlineQueryResult {
@@ -27,7 +28,7 @@ public:
}
/**
- * A valid file identifier of the sticker
+ * @brief A valid file identifier of the sticker
*/
std::string stickerFileId;
};
diff --git a/include/tgbot/types/InlineQueryResultCachedVideo.h b/include/tgbot/types/InlineQueryResultCachedVideo.h
index d4304d6..8b24c76 100644
--- a/include/tgbot/types/InlineQueryResultCachedVideo.h
+++ b/include/tgbot/types/InlineQueryResultCachedVideo.h
@@ -13,8 +13,9 @@
namespace TgBot {
/**
- * Represents a link to a video file stored on the Telegram servers.
- * @ingroup types
+ * @brief Represents a link to a video file stored on the Telegram servers.
+ *
+ * @ingroup types
*/
class InlineQueryResultCachedVideo : public InlineQueryResult {
public:
@@ -27,12 +28,12 @@ public:
}
/**
- * A valid file identifier of the video
+ * @brief A valid file identifier of the video
*/
std::string videoFileId;
/**
- * Optional. Short description of the result
+ * @brief Optional. Short description of the result
*/
std::string description;
};
diff --git a/include/tgbot/types/InlineQueryResultCachedVoice.h b/include/tgbot/types/InlineQueryResultCachedVoice.h
index a0d1a9e..8b4fb42 100644
--- a/include/tgbot/types/InlineQueryResultCachedVoice.h
+++ b/include/tgbot/types/InlineQueryResultCachedVoice.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a link to a voice message stored on the Telegram servers.
+ * @brief Represents a link to a voice message stored on the Telegram servers.
+ *
* @ingroup types
*/
class InlineQueryResultCachedVoice : public InlineQueryResult {
@@ -27,7 +28,7 @@ public:
}
/**
- * A valid file identifier of the voice message
+ * @brief A valid file identifier of the voice message
*/
std::string voiceFileId;
};
diff --git a/include/tgbot/types/InlineQueryResultContact.h b/include/tgbot/types/InlineQueryResultContact.h
index ac9dca7..a6a562a 100644
--- a/include/tgbot/types/InlineQueryResultContact.h
+++ b/include/tgbot/types/InlineQueryResultContact.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a contact with a phone number
+ * @brief Represents a contact with a phone number
+ *
* @ingroup types
*/
class InlineQueryResultContact : public InlineQueryResult {
@@ -29,32 +30,32 @@ public:
}
/**
- * Contact's phone number
+ * @brief Contact's phone number
*/
std::string phoneNumber;
/**
- * Contact's first name
+ * @brief Contact's first name
*/
std::string firstName;
/**
- * Optional. Contact's last name
+ * @brief Optional. Contact's last name
*/
std::string lastName;
/**
- * Optional. Url of the thumbnail for the result
+ * @brief Optional. Url of the thumbnail for the result
*/
std::string thumbUrl;
/**
- * Optional. Thumbnail width.
+ * @brief Optional. Thumbnail width.
*/
int32_t thumbWidth;
/**
- * Optinal. Thumbnail height
+ * @brief Optinal. Thumbnail height
*/
int32_t thumbHeight;
};
diff --git a/include/tgbot/types/InlineQueryResultDocument.h b/include/tgbot/types/InlineQueryResultDocument.h
index 3b5e9ad..7f08ba8 100644
--- a/include/tgbot/types/InlineQueryResultDocument.h
+++ b/include/tgbot/types/InlineQueryResultDocument.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a link to a file.
+ * @brief Represents a link to a file.
+ *
* @ingroup types
*/
class InlineQueryResultDocument : public InlineQueryResult {
@@ -29,32 +30,32 @@ public:
}
/**
- * A valid URL for the file
+ * @brief A valid URL for the file
*/
std::string documentUrl;
/**
- * Mime type of the content of the file, either �application/pdf� or �application/zip�
+ * @brief Mime type of the content of the file, either 'application/pdf' or 'application/zip'
*/
std::string mimeType;
/**
- * Optional. Short description of the result
+ * @brief Optional. Short description of the result
*/
std::string description;
/**
- * Optional. Url of the thumbnail for the result
+ * @brief Optional. Url of the thumbnail for the result
*/
std::string thumbUrl;
/**
- * Optional. Thumbnail width.
+ * @brief Optional. Thumbnail width.
*/
int32_t thumbWidth;
/**
- * Optinal. Thumbnail height
+ * @brief Optinal. Thumbnail height
*/
int32_t thumbHeight;
};
diff --git a/include/tgbot/types/InlineQueryResultGame.h b/include/tgbot/types/InlineQueryResultGame.h
index da419bd..46fb626 100644
--- a/include/tgbot/types/InlineQueryResultGame.h
+++ b/include/tgbot/types/InlineQueryResultGame.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a Game.
+ * @brief Represents a Game.
+ *
* @ingroup types
*/
class InlineQueryResultGame : public InlineQueryResult {
@@ -27,7 +28,7 @@ public:
}
/**
- * Short name of the game
+ * @brief Short name of the game
*/
std::string gameShortName;
};
diff --git a/include/tgbot/types/InlineQueryResultGif.h b/include/tgbot/types/InlineQueryResultGif.h
index 1b6f9a3..55789c3 100644
--- a/include/tgbot/types/InlineQueryResultGif.h
+++ b/include/tgbot/types/InlineQueryResultGif.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a link to an animated GIF file.
+ * @brief Represents a link to an animated GIF file.
+ *
* @ingroup types
*/
class InlineQueryResultGif : public InlineQueryResult {
@@ -29,27 +30,27 @@ public:
}
/**
- * A valid URL for the GIF file.
+ * @brief A valid URL for the GIF file.
*/
std::string gifUrl;
/**
- * Optional. Width of the GIF.
+ * @brief Optional. Width of the GIF.
*/
int32_t gifWidth;
/**
- * Optional. Height of the GIF.
+ * @brief Optional. Height of the GIF.
*/
int32_t gifHeight;
/**
- * Optional. Duration of the GIF
+ * @brief Optional. Duration of the GIF
*/
int32_t gifDuration;
/**
- * URL of the static thumbnail for the result (jpeg or gif)
+ * @brief URL of the static thumbnail for the result (jpeg or gif)
*/
std::string thumbUrl;
diff --git a/include/tgbot/types/InlineQueryResultLocation.h b/include/tgbot/types/InlineQueryResultLocation.h
index 446615e..c3fd22c 100644
--- a/include/tgbot/types/InlineQueryResultLocation.h
+++ b/include/tgbot/types/InlineQueryResultLocation.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a location on a map.
+ * @brief Represents a location on a map.
+ *
* @ingroup types
*/
class InlineQueryResultLocation : public InlineQueryResult {
@@ -29,27 +30,27 @@ public:
}
/**
- * Location latitude in degrees
+ * @brief Location latitude in degrees
*/
float latitude;
/**
- * Location longitude in degrees
+ * @brief Location longitude in degrees
*/
float longitude;
/**
- * Optional. Url of the thumbnail for the result
+ * @brief Optional. Url of the thumbnail for the result
*/
std::string thumbUrl;
/**
- * Optional. Thumbnail width.
+ * @brief Optional. Thumbnail width.
*/
int32_t thumbWidth;
/**
- * Optinal. Thumbnail height
+ * @brief Optinal. Thumbnail height
*/
int32_t thumbHeight;
};
diff --git a/include/tgbot/types/InlineQueryResultMpeg4Gif.h b/include/tgbot/types/InlineQueryResultMpeg4Gif.h
index 9727281..347d8cb 100644
--- a/include/tgbot/types/InlineQueryResultMpeg4Gif.h
+++ b/include/tgbot/types/InlineQueryResultMpeg4Gif.h
@@ -8,7 +8,8 @@
namespace TgBot {
/**
- * Represents a link to a video animation (H.264/MPEG-4 AVC video without sound).
+ * @brief Represents a link to a video animation (H.264/MPEG-4 AVC video without sound).
+ *
* @ingroup types
*/
class InlineQueryResultMpeg4Gif : public InlineQueryResult {
@@ -24,27 +25,27 @@ public:
}
/**
- * A valid URL for the MP4 file.
+ * @brief A valid URL for the MP4 file.
*/
std::string mpeg4Url;
/**
- * Optional. Video width.
+ * @brief Optional. Video width.
*/
int32_t mpeg4Width;
/**
- * Optional. Video height.
+ * @brief Optional. Video height.
*/
int32_t mpeg4Height;
/**
- * Optional. Video duration.
+ * @brief Optional. Video duration.
*/
int32_t mpeg4Duration;
/**
- * URL of the static thumbnail (jpeg or gif) for the result
+ * @brief URL of the static thumbnail (jpeg or gif) for the result
*/
std::string thumbUrl;
diff --git a/include/tgbot/types/InlineQueryResultPhoto.h b/include/tgbot/types/InlineQueryResultPhoto.h
index c655d9b..011362c 100644
--- a/include/tgbot/types/InlineQueryResultPhoto.h
+++ b/include/tgbot/types/InlineQueryResultPhoto.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a link to a photo.
+ * @brief Represents a link to a photo.
+ *
* @ingroup types
*/
class InlineQueryResultPhoto : public InlineQueryResult {
@@ -29,27 +30,27 @@ public:
}
/**
- * A valid URL of the photo.
+ * @brief A valid URL of the photo.
*/
std::string photoUrl;
/**
- * URL of the thumbnail for the photo
+ * @brief URL of the thumbnail for the photo
*/
std::string thumbUrl;
/**
- * Optional. Width of the photo.
+ * @brief Optional. Width of the photo.
*/
int32_t photoWidth;
/**
- * Optional. Height of the photo.
+ * @brief Optional. Height of the photo.
*/
int32_t photoHeight;
/**
- * Optional. Short description of the result.
+ * @brief Optional. Short description of the result.
*/
std::string description;
};
diff --git a/include/tgbot/types/InlineQueryResultVenue.h b/include/tgbot/types/InlineQueryResultVenue.h
index 6d19b65..7f00dd0 100644
--- a/include/tgbot/types/InlineQueryResultVenue.h
+++ b/include/tgbot/types/InlineQueryResultVenue.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * Represents a venue.
+ * @brief Represents a venue.
+ *
* @ingroup types
*/
class InlineQueryResultVenue : public InlineQueryResult {
@@ -29,37 +30,37 @@ public:
}
/**
- * Latitude of the venue location in degrees
+ * @brief Latitude of the venue location in degrees
*/
float latitude;
/**
- * Longitude of the venue location in degrees
+ * @brief Longitude of the venue location in degrees
*/
float longitude;
/**
- * Address of the venue
+ * @brief Address of the venue
*/
std::string address;
/**
- * Optional. Foursquare identifier of the venue if known
+ * @brief Optional. Foursquare identifier of the venue if known
*/
std::string foursquareId;
/**
- * Optional. Url of the thumbnail for the result
+ * @brief Optional. Url of the thumbnail for the result
*/
std::string thumbUrl;
/**
- * Optional. Thumbnail width.
+ * @brief Optional. Thumbnail width.
*/
int32_t thumbWidth;
/**
- * Optinal. Thumbnail height
+ * @brief Optinal. Thumbnail height
*/
int32_t thumbHeight;
};
diff --git a/include/tgbot/types/InlineQueryResultVideo.h b/include/tgbot/types/InlineQueryResultVideo.h
index 1515486..563fa9a 100644
--- a/include/tgbot/types/InlineQueryResultVideo.h
+++ b/include/tgbot/types/InlineQueryResultVideo.h
@@ -8,7 +8,8 @@
namespace TgBot {
/**
- * Represents link to a page containing an embedded video player or a video file.
+ * @brief Represents link to a page containing an embedded video player or a video file.
+ *
* @ingroup types
*/
class InlineQueryResultVideo : public InlineQueryResult {
@@ -25,37 +26,37 @@ public:
};
/**
- * A valid URL for the embedded video player or video file.
+ * @brief A valid URL for the embedded video player or video file.
*/
std::string videoUrl;
/**
- * Mime type of the content of video url, "text/html" or "video/mp4".
+ * @brief Mime type of the content of video url, "text/html" or "video/mp4".
*/
std::string mimeType;
/**
- * URL of the thumbnail (jpeg only) for the video
+ * @brief URL of the thumbnail (jpeg only) for the video
*/
std::string thumbUrl;
/**
- * Optional. Video width.
+ * @brief Optional. Video width.
*/
int32_t videoWidth;
/**
- * Optional. Video height.
+ * @brief Optional. Video height.
*/
int32_t videoHeight;
/**
- * Optional. Video duration.
+ * @brief Optional. Video duration.
*/
int32_t videoDuration;
/**
- * Optional. Short description of the result.
+ * @brief Optional. Short description of the result.
*/
std::string description;
diff --git a/include/tgbot/types/InlineQueryResultVoice.h b/include/tgbot/types/InlineQueryResultVoice.h
index 2bc4aac..49710ea 100644
--- a/include/tgbot/types/InlineQueryResultVoice.h
+++ b/include/tgbot/types/InlineQueryResultVoice.h
@@ -8,7 +8,8 @@
namespace TgBot {
/**
- * Represents link to a page containing an embedded video player or a video file.
+ * @brief Represents link to a page containing an embedded video player or a video file.
+ *
* @ingroup types
*/
class InlineQueryResultVoice : public InlineQueryResult {
@@ -23,12 +24,12 @@ public:
};
/**
- * A valid URL for the voice recording
+ * @brief A valid URL for the voice recording
*/
std::string voiceUrl;
/**
- * Optional. Recording duration in seconds
+ * @brief Optional. Recording duration in seconds
*/
int32_t voiceDuration;
};
diff --git a/include/tgbot/types/InputContactMessageContent.h b/include/tgbot/types/InputContactMessageContent.h
index 421093c..4f5cf42 100644
--- a/include/tgbot/types/InputContactMessageContent.h
+++ b/include/tgbot/types/InputContactMessageContent.h
@@ -11,9 +11,10 @@
namespace TgBot {
/**
-* Represents the content of a contact message to be sent as the result of an inline query.
-* @ingroup types
-*/
+ * @brief Represents the content of a contact message to be sent as the result of an inline query.
+ *
+ * @ingroup types
+ */
class InputContactMessageContent : public InputMessageContent {
public:
typedef std::shared_ptr<InputContactMessageContent> Ptr;
@@ -23,18 +24,18 @@ public:
{}
/**
- * Contact's phone number
- */
+ * @brief Contact's phone number
+ */
std::string phoneNumber;
/**
- * Contact's first name
- */
+ * @brief Contact's first name
+ */
std::string firstName;
/**
- * Optional. Contact's last name
- */
+ * @brief Optional. Contact's last name
+ */
std::string lastName;
virtual ~InputContactMessageContent() { }
diff --git a/include/tgbot/types/InputFile.h b/include/tgbot/types/InputFile.h
index c56ab7a..9c483d3 100644
--- a/include/tgbot/types/InputFile.h
+++ b/include/tgbot/types/InputFile.h
@@ -30,7 +30,8 @@
namespace TgBot {
/**
- * This object represents the contents of a file to be uploaded.
+ * @brief This object represents the contents of a file to be uploaded.
+ *
* @ingroup types
*/
class InputFile {
@@ -39,22 +40,22 @@ public:
typedef std::shared_ptr<InputFile> Ptr;
/**
- * Contents of a file.
+ * @brief Contents of a file.
*/
std::string data;
/**
- * Mime type of a file.
+ * @brief Mime type of a file.
*/
std::string mimeType;
/**
- * File name.
+ * @brief File name.
*/
std::string fileName;
/**
- * Creates new InputFile::Ptr from an existing file.
+ * @brief Creates new InputFile::Ptr from an existing file.
*/
static InputFile::Ptr fromFile(const std::string& filePath, const std::string& mimeType);
};
diff --git a/include/tgbot/types/InputLocationMessageContent.h b/include/tgbot/types/InputLocationMessageContent.h
index 3405353..871ad4c 100644
--- a/include/tgbot/types/InputLocationMessageContent.h
+++ b/include/tgbot/types/InputLocationMessageContent.h
@@ -10,9 +10,10 @@
namespace TgBot {
/**
-* Represents the content of a location message to be sent as the result of an inline query.
-* @ingroup types
-*/
+ * @brief Represents the content of a location message to be sent as the result of an inline query.
+ *
+ * @ingroup types
+ */
class InputLocationMessageContent : public InputMessageContent {
public:
typedef std::shared_ptr<InputLocationMessageContent> Ptr;
@@ -22,13 +23,13 @@ public:
{}
/**
- * Latitude of the location in degrees
- */
+ * @brief Latitude of the location in degrees
+ */
float latitude;
/**
- * Longitude of the location in degrees
- */
+ * @brief Longitude of the location in degrees
+ */
float longitude;
virtual ~InputLocationMessageContent() { }
diff --git a/include/tgbot/types/InputMedia.h b/include/tgbot/types/InputMedia.h
index d7c3ace..c59df20 100644
--- a/include/tgbot/types/InputMedia.h
+++ b/include/tgbot/types/InputMedia.h
@@ -31,9 +31,10 @@
namespace TgBot {
/**
-* This object represents the content of a media message to be sent.
-* @ingroup types
-*/
+ * @brief This object represents the content of a media message to be sent.
+ *
+ * @ingroup types
+ */
class InputMedia {
public:
typedef std::shared_ptr<InputMedia> Ptr;
@@ -44,42 +45,42 @@ public:
};
/**
- * Type of the result, It should be one of TYPE::PHOTO/TYPE::VIDEO
+ * @brief Type of the result, It should be one of TYPE::PHOTO/TYPE::VIDEO
*/
TYPE type;
/**
- * File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name.
+ * @brief File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet, or pass "attach://<file_attach_name>" to upload a new one using multipart/form-data under <file_attach_name> name.
*/
std::string media;
/**
- * Optional. Caption of the photo to be sent, 0-200 characters
+ * @brief Optional. Caption of the photo to be sent, 0-200 characters
*/
std::string caption;
/**
- * Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.
+ * @brief Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption.
*/
std::string parseMode;
/**
- * Optional. Video width
+ * @brief Optional. Video width
*/
int32_t width = 0;
/**
- * Optional. Video height
+ * @brief Optional. Video height
*/
int32_t height = 0;
/**
- * Optional. Video duration
+ * @brief Optional. Video duration
*/
int32_t duration = 0;
/**
- * Optional. Pass True, if the uploaded video is suitable for streaming
+ * @brief Optional. Pass True, if the uploaded video is suitable for streaming
*/
bool supportsStreaming = false;
};
diff --git a/include/tgbot/types/InputMediaPhoto.h b/include/tgbot/types/InputMediaPhoto.h
index 6d8af86..4c6cc64 100644
--- a/include/tgbot/types/InputMediaPhoto.h
+++ b/include/tgbot/types/InputMediaPhoto.h
@@ -33,9 +33,9 @@
namespace TgBot {
/**
-* Represents a photo to be sent.
-* @ingroup types
-*/
+ * @brief Represents a photo to be sent.
+ * @ingroup types
+ */
class InputMediaPhoto : public InputMedia {
public:
typedef std::shared_ptr<InputMediaPhoto> Ptr;
diff --git a/include/tgbot/types/InputMediaVideo.h b/include/tgbot/types/InputMediaVideo.h
index a49c80a..3a2d17a 100644
--- a/include/tgbot/types/InputMediaVideo.h
+++ b/include/tgbot/types/InputMediaVideo.h
@@ -33,9 +33,9 @@
namespace TgBot {
/**
-* Represents a video to be sent.
-* @ingroup types
-*/
+ * @brief Represents a video to be sent.
+ * @ingroup types
+ */
class InputMediaVideo : public InputMedia {
public:
typedef std::shared_ptr<InputMediaVideo> Ptr;
diff --git a/include/tgbot/types/InputMessageContent.h b/include/tgbot/types/InputMessageContent.h
index 1abdec6..7e2845e 100644
--- a/include/tgbot/types/InputMessageContent.h
+++ b/include/tgbot/types/InputMessageContent.h
@@ -11,9 +11,9 @@
namespace TgBot {
/**
-* This object represents the content of a message to be sent as a result of an inline query.
-* @ingroup types
-*/
+ * @brief This object represents the content of a message to be sent as a result of an inline query.
+ * @ingroup types
+ */
class InputMessageContent {
public:
typedef std::shared_ptr<InputMessageContent> Ptr;
diff --git a/include/tgbot/types/InputTextMessageContent.h b/include/tgbot/types/InputTextMessageContent.h
index 4c33069..64d0f02 100644
--- a/include/tgbot/types/InputTextMessageContent.h
+++ b/include/tgbot/types/InputTextMessageContent.h
@@ -11,9 +11,10 @@
namespace TgBot {
/**
-* Represents the content of a text message to be sent as the result of an inline query.
-* @ingroup types
-*/
+ * @brief Represents the content of a text message to be sent as the result of an inline query.
+ *
+ * @ingroup types
+ */
class InputTextMessageContent : public InputMessageContent {
public:
typedef std::shared_ptr<InputTextMessageContent> Ptr;
@@ -23,18 +24,18 @@ public:
{}
/**
- * Text of the message to be sent, 1-4096 characters
- */
+ * @brief Text of the message to be sent, 1-4096 characters
+ */
std::string messageText;
/**
- * Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
- */
+ * @brief Optional. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in your bot's message.
+ */
std::string parseMode;
/**
- * Optional. Disables link previews for links in the sent message
- */
+ * @brief Optional. Disables link previews for links in the sent message
+ */
bool disableWebPagePreview;
virtual ~InputTextMessageContent() { }
diff --git a/include/tgbot/types/InputVenueMessageContent.h b/include/tgbot/types/InputVenueMessageContent.h
index 3ffc998..21df481 100644
--- a/include/tgbot/types/InputVenueMessageContent.h
+++ b/include/tgbot/types/InputVenueMessageContent.h
@@ -12,9 +12,10 @@
namespace TgBot {
/**
-* Represents the content of a venue message to be sent as the result of an inline query.
-* @ingroup types
-*/
+ * @brief Represents the content of a venue message to be sent as the result of an inline query.
+ *
+ * @ingroup types
+ */
class InputVenueMessageContent : public InputMessageContent {
public:
typedef std::shared_ptr<InputVenueMessageContent> Ptr;
@@ -24,28 +25,28 @@ public:
{}
/**
- * Latitude of the location in degrees
- */
+ * @brief Latitude of the location in degrees
+ */
float latitude;
/**
- * Longitude of the location in degrees
- */
+ * @brief Longitude of the location in degrees
+ */
float longitude;
/**
- * Name of the venue
+ * @brief Name of the venue
*/
std::string title;
/**
- * Address of the venue
- */
+ * @brief Address of the venue
+ */
std::string address;
/**
- * Optional. Foursquare identifier of the venue, if known
- */
+ * @brief Optional. Foursquare identifier of the venue, if known
+ */
std::string foursquareId;
virtual ~InputVenueMessageContent() { }
diff --git a/include/tgbot/types/KeyboardButton.h b/include/tgbot/types/KeyboardButton.h
index 204c579..4fa0fd4 100644
--- a/include/tgbot/types/KeyboardButton.h
+++ b/include/tgbot/types/KeyboardButton.h
@@ -11,9 +11,11 @@
namespace TgBot {
/**
- * This object represents one button of the reply keyboard.
+ * @brief This object represents one button of the reply keyboard.
+ *
* For simple text buttons String can be used instead of this
* object to specify text of the button. Optional fields are mutually exclusive.
+ *
* @ingroup types
*/
class KeyboardButton {
@@ -22,19 +24,19 @@ public:
typedef std::shared_ptr<KeyboardButton> Ptr;
/**
- * Text of the button. If none of the optional fields are used,
+ * @brief Text of the button. If none of the optional fields are used,
* it will be sent to the bot as a message when the button is pressed
*/
std::string text;
/**
- * Optional. If True, the user's phone number will be sent as a contact
+ * @brief Optional. If True, the user's phone number will be sent as a contact
* when the button is pressed. Available in private chats only
*/
bool requestContact = false;
/**
- * Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only.
+ * @brief Optional. If True, the user's current location will be sent when the button is pressed. Available in private chats only.
*/
bool requestLocation = false;
};
diff --git a/include/tgbot/types/Location.h b/include/tgbot/types/Location.h
index 9d9ef72..2144b8c 100644
--- a/include/tgbot/types/Location.h
+++ b/include/tgbot/types/Location.h
@@ -28,7 +28,8 @@
namespace TgBot {
/**
- * This object represents a point on the map.
+ * @brief This object represents a point on the map.
+ *
* @ingroup types
*/
class Location {
@@ -37,12 +38,12 @@ public:
typedef std::shared_ptr<Location> Ptr;
/**
- * Longitude as defined by sender.
+ * @brief Longitude as defined by sender.
*/
float longitude;
/**
- * Latitude as defined by sender.
+ * @brief Latitude as defined by sender.
*/
float latitude;
};
diff --git a/include/tgbot/types/MaskPosition.h b/include/tgbot/types/MaskPosition.h
index edd5d5e..67dd6d3 100644
--- a/include/tgbot/types/MaskPosition.h
+++ b/include/tgbot/types/MaskPosition.h
@@ -30,7 +30,8 @@
namespace TgBot {
/**
- * This object describes the position on faces where a mask should be placed by default.
+ * @brief This object describes the position on faces where a mask should be placed by default.
+ *
* @ingroup types
*/
class MaskPosition {
@@ -38,22 +39,22 @@ public:
typedef std::shared_ptr<MaskPosition> Ptr;
/**
- * The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.
+ * @brief The part of the face relative to which the mask should be placed. One of “forehead”, “eyes”, “mouth”, or “chin”.
*/
std::string point;
/**
- * Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.
+ * @brief Shift by X-axis measured in widths of the mask scaled to the face size, from left to right. For example, choosing -1.0 will place mask just to the left of the default mask position.
*/
float xShift;
/**
- * Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.
+ * @brief Shift by Y-axis measured in heights of the mask scaled to the face size, from top to bottom. For example, 1.0 will place the mask just below the default mask position.
*/
float yShift;
/**
- * Mask scaling coefficient. For example, 2.0 means double size.
+ * @brief Mask scaling coefficient. For example, 2.0 means double size.
*/
float scale;
};
diff --git a/include/tgbot/types/Message.h b/include/tgbot/types/Message.h
index 87d6067..6b7484f 100644
--- a/include/tgbot/types/Message.h
+++ b/include/tgbot/types/Message.h
@@ -44,7 +44,8 @@
namespace TgBot {
/**
- * This object represents a message.
+ * @brief This object represents a message.
+ *
* @ingroup types
*/
class Message {
@@ -61,192 +62,192 @@ public:
}
/**
- * Unique message identifier.
+ * @brief Unique message identifier.
*/
int32_t messageId;
/**
- * Optional. Sender, can be empty for messages sent to channels.
+ * @brief Optional. Sender, can be empty for messages sent to channels.
*/
User::Ptr from;
/**
- * Date the message was sent in Unix time.
+ * @brief Date the message was sent in Unix time.
*/
int32_t date;
/**
- * Conversation the message belongs to.
+ * @brief Conversation the message belongs to.
*/
Chat::Ptr chat;
/**
- * Optional. For forwarded messages, sender of the original message.
+ * @brief Optional. For forwarded messages, sender of the original message.
*/
User::Ptr forwardFrom;
/**
- * Optional. For messages forwarded from a channel, information about the original channel
+ * @brief Optional. For messages forwarded from a channel, information about the original channel
*/
Chat::Ptr forwardFromChat;
/**
- * Optional. For forwarded channel posts, identifier of the original message in the channel
+ * @brief Optional. For forwarded channel posts, identifier of the original message in the channel
*/
int32_t forwardFromMessageId;
/**
- * Optional. For messages forwarded from channels, signature of the post author if present.
+ * @brief Optional. For messages forwarded from channels, signature of the post author if present.
*/
std::string forwardSignature;
/**
- * Optional. For forwarded messages, date the original message was sent in Unix time.
+ * @brief Optional. For forwarded messages, date the original message was sent in Unix time.
*/
int32_t forwardDate;
/**
- * Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
+ * @brief Optional. For replies, the original message. Note that the Message object in this field will not contain further reply_to_message fields even if it itself is a reply.
*/
Message::Ptr replyToMessage;
/**
- * Optional. Date the message was last edited in Unix time.
+ * @brief Optional. Date the message was last edited in Unix time.
*/
int32_t editDate;
/**
- * Optional. Signature of the post author for messages in channels.
+ * @brief Optional. Signature of the post author for messages in channels.
*/
std::string authorSignature;
/**
- * Optional. For text messages, the actual UTF-8 text of the message.
+ * @brief Optional. For text messages, the actual UTF-8 text of the message.
*/
std::string text;
/**
- * Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text.
+ * @brief Optional. For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text.
*/
std::vector<MessageEntity::Ptr> entities;
/**
- * Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption
+ * @brief Optional. For messages with a caption, special entities like usernames, URLs, bot commands, etc. that appear in the caption
*/
std::vector<MessageEntity::Ptr> captionEntities;
/**
- * Optional. Message is an audio file, information about the file.
+ * @brief Optional. Message is an audio file, information about the file.
*/
Audio::Ptr audio;
/**
- * Optional. Message is a general file, information about the file.
+ * @brief Optional. Message is a general file, information about the file.
*/
Document::Ptr document;
/**
- * Optional. Message is a photo, available sizes of the photo.
+ * @brief Optional. Message is a photo, available sizes of the photo.
*/
std::vector<PhotoSize::Ptr> photo;
/**
- * Optional. Message is a sticker, information about the sticker.
+ * @brief Optional. Message is a sticker, information about the sticker.
*/
Sticker::Ptr sticker;
/**
- * Optional. Message is a video, information about the video.
+ * @brief Optional. Message is a video, information about the video.
*/
Video::Ptr video;
/**
- * Optional. Message is a voice message, information about the file.
+ * @brief Optional. Message is a voice message, information about the file.
*/
Voice::Ptr voice;
/**
- * Optional. Caption for the document, photo or video, 0-200 characters.
+ * @brief Optional. Caption for the document, photo or video, 0-200 characters.
*/
std::string caption;
/**
- * Optional. Message is a shared contact, information about the contact.
+ * @brief Optional. Message is a shared contact, information about the contact.
*/
Contact::Ptr contact;
/**
- * Optional. Message is a shared location, information about the location.
+ * @brief Optional. Message is a shared location, information about the location.
*/
Location::Ptr location;
/**
- * Optional. Message is a venue, information about the venue.
+ * @brief Optional. Message is a venue, information about the venue.
*/
Venue::Ptr venue;
/**
- * Optional. A new member was added to the group, information about them (this member may be bot itself).
+ * @brief Optional. A new member was added to the group, information about them (this member may be bot itself).
*/
User::Ptr newChatMember;
/**
- * Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)
+ * @brief Optional. New members that were added to the group or supergroup and information about them (the bot itself may be one of these members)
*/
std::vector<User::Ptr> newChatMembers;
/**
- * Optional. A member was removed from the group, information about them (this member may be bot itself).
+ * @brief Optional. A member was removed from the group, information about them (this member may be bot itself).
*/
User::Ptr leftChatMember;
/**
- * Optional. A group title was changed to this value.
+ * @brief Optional. A group title was changed to this value.
*/
std::string newChatTitle;
/**
- * Optional. A group photo was change to this value.
+ * @brief Optional. A group photo was change to this value.
*/
std::vector<PhotoSize::Ptr> newChatPhoto;
/**
- * Optional. Informs that the group photo was deleted.
+ * @brief Optional. Informs that the group photo was deleted.
*/
bool deleteChatPhoto;
/**
- * Optional. Informs that the group has been created.
+ * @brief Optional. Informs that the group has been created.
*/
bool groupChatCreated;
/**
- * Optional. Service message: the supergroup has been created.
+ * @brief Optional. Service message: the supergroup has been created.
*/
bool supergroupChatCreated;
/**
- * Optional. Service message: the channel has been created.
+ * @brief Optional. Service message: the channel has been created.
*/
bool channelChatCreated;
/**
- * Optional. The group has been migrated to a supergroup with the specified identifier, not exceeding 1e13 by absolute value.
+ * @brief Optional. The group has been migrated to a supergroup with the specified identifier, not exceeding 1e13 by absolute value.
*/
int64_t migrateToChatId;
/**
- * Optional. The supergroup has been migrated from a group with the specified identifier, not exceeding 1e13 by absolute value
+ * @brief Optional. The supergroup has been migrated from a group with the specified identifier, not exceeding 1e13 by absolute value
*/
int64_t migrateFromChatId;
/**
- * Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply.
+ * @brief Optional. Specified message was pinned. Note that the Message object in this field will not contain further reply_to_message fields even if it is itself a reply.
*/
Message::Ptr pinnedMessage;
/**
- * Optional. The domain name of the website on which the user has logged in.
+ * @brief Optional. The domain name of the website on which the user has logged in.
*/
std::string connectedWebsite;
};
diff --git a/include/tgbot/types/MessageEntity.h b/include/tgbot/types/MessageEntity.h
index ad445cf..e551d6e 100644
--- a/include/tgbot/types/MessageEntity.h
+++ b/include/tgbot/types/MessageEntity.h
@@ -12,7 +12,8 @@
namespace TgBot {
/**
- * This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
+ * @brief This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc.
+ *
* @ingroup types
*/
class MessageEntity {
@@ -20,27 +21,27 @@ public:
typedef std::shared_ptr<MessageEntity> Ptr;
/**
- * Type of the entity. One of mention (@username), hashtag, bot_command, url, email, bold (bold text), italic (italic text), code (monowidth string), pre (monowidth block), text_link (for clickable text URLs).
+ * @brief Type of the entity. One of mention (@username), hashtag, bot_command, url, email, bold (bold text), italic (italic text), code (monowidth string), pre (monowidth block), text_link (for clickable text URLs).
*/
std::string type;
/**
- * Offset in UTF-16 code units to the start of the entity.
+ * @brief Offset in UTF-16 code units to the start of the entity.
*/
int32_t offset;
/**
- * Length of the entity in UTF-16 code units
+ * @brief Length of the entity in UTF-16 code units
*/
int32_t length;
/**
- * Optional. For “text_link” only, url that will be opened after user taps on the text
+ * @brief Optional. For “text_link” only, url that will be opened after user taps on the text
*/
std::string url;
/**
- * Optional. For “text_mention” only, the mentioned user
+ * @brief Optional. For “text_mention” only, the mentioned user
*/
User::Ptr user;
};
diff --git a/include/tgbot/types/PhotoSize.h b/include/tgbot/types/PhotoSize.h
index 0ccea49..8e87469 100644
--- a/include/tgbot/types/PhotoSize.h
+++ b/include/tgbot/types/PhotoSize.h
@@ -29,7 +29,8 @@
namespace TgBot {
/**
- * This object represents one size of a photo or a file / sticker thumbnail.
+ * @brief This object represents one size of a photo or a file / sticker thumbnail.
+ *
* @ingroup types
*/
class PhotoSize {
@@ -38,22 +39,22 @@ public:
typedef std::shared_ptr<PhotoSize> Ptr;
/**
- * Unique identifier for this file.
+ * @brief Unique identifier for this file.
*/
std::string fileId;
/**
- * Photo width.
+ * @brief Photo width.
*/
int32_t width;
/**
- * Photo height.
+ * @brief Photo height.
*/
int32_t height;
/**
- * Optional. File size.
+ * @brief Optional. File size.
*/
int32_t fileSize;
};
diff --git a/include/tgbot/types/ReplyKeyboardMarkup.h b/include/tgbot/types/ReplyKeyboardMarkup.h
index f6e50db..84d4a60 100644
--- a/include/tgbot/types/ReplyKeyboardMarkup.h
+++ b/include/tgbot/types/ReplyKeyboardMarkup.h
@@ -33,7 +33,8 @@
namespace TgBot {
/**
- * This object represents a custom keyboard with reply options.
+ * @brief This object represents a custom keyboard with reply options.
+ *
* @ingroup types
*/
class ReplyKeyboardMarkup : public GenericReply {
@@ -42,22 +43,23 @@ public:
typedef std::shared_ptr<ReplyKeyboardMarkup> Ptr;
/**
- * Array of button rows, each represented by an Array of KeyboardButton.
+ * @brief Array of button rows, each represented by an Array of KeyboardButton.
*/
std::vector<std::vector<KeyboardButton::Ptr>> keyboard;
/**
- * Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.
+ * @brief Optional. Requests clients to resize the keyboard vertically for optimal fit (e.g., make the keyboard smaller if there are just two rows of buttons). Defaults to false, in which case the custom keyboard is always of the same height as the app's standard keyboard.
*/
bool resizeKeyboard = false;
/**
- * Optional. Requests clients to hide the keyboard as soon as it's been used. Defaults to false.
+ * @brief Optional. Requests clients to hide the keyboard as soon as it's been used. Defaults to false.
*/
bool oneTimeKeyboard = false;
/**
- * Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
+ * @brief Optional. Use this parameter if you want to show the keyboard to specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
+ *
* Example: A user requests to change the bot‘s language, bot replies to the request with a keyboard to select the new language. Other users in the group don’t see the keyboard.
*/
bool selective = false;
diff --git a/include/tgbot/types/ReplyKeyboardRemove.h b/include/tgbot/types/ReplyKeyboardRemove.h
index c47fb7d..dbe6f2b 100644
--- a/include/tgbot/types/ReplyKeyboardRemove.h
+++ b/include/tgbot/types/ReplyKeyboardRemove.h
@@ -12,9 +12,11 @@
namespace TgBot {
/**
- * Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard.
+ * @brief Upon receiving a message with this object, Telegram clients will remove the current custom keyboard and display the default letter-keyboard.
+ *
* By default, custom keyboards are displayed until a new keyboard is sent by a bot. An exception is made for one-time keyboards that are hidden
* immediately after the user presses a button (see ReplyKeyboardMarkup).
+ *
* @ingroup types
*/
class ReplyKeyboardRemove : public GenericReply {
@@ -23,13 +25,15 @@ public:
typedef std::shared_ptr<ReplyKeyboardRemove> Ptr;
/**
- * Requests clients to remove the custom keyboard (user will not be able to summon this keyboard;
+ * @brief Requests clients to remove the custom keyboard (user will not be able to summon this keyboard;
+ *
* if you want to hide the keyboard from sight but keep it accessible, use one_time_keyboard in ReplyKeyboardMarkup)
*/
const bool removeKeyboard = true;
/**
- * Optional. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
+ * @brief Optional. Use this parameter if you want to remove the keyboard for specific users only. Targets: 1) users that are @mentioned in the text of the Message object; 2) if the bot's message is a reply (has reply_to_message_id), sender of the original message.
+ *
* Example: A user votes in a poll, bot returns confirmation message in reply to the vote and removes the keyboard for that user, while still showing the keyboard with poll options to users who haven't voted yet.
*/
bool selective = false;
diff --git a/include/tgbot/types/ResponseParameters.h b/include/tgbot/types/ResponseParameters.h
index 0c8bba9..c55a15f 100644
--- a/include/tgbot/types/ResponseParameters.h
+++ b/include/tgbot/types/ResponseParameters.h
@@ -10,7 +10,8 @@
namespace TgBot {
/**
- * Contains information about why a request was unsuccessfull.
+ * @brief Contains information about why a request was unsuccessfull.
+ *
* @ingroup types
*/
class ResponseParameters {
@@ -18,7 +19,8 @@ public:
typedef std::shared_ptr<ResponseParameters> Ptr;
/**
- * Optional. The group has been migrated to a supergroup with the specified identifier.
+ * @brief Optional. The group has been migrated to a supergroup with the specified identifier.
+ *
* This number may be greater than 32 bits and some programming languages may have
* difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a
* signed 64 bit integer or double-precision float type are safe for storing this identifier.
@@ -26,7 +28,7 @@ public:
int32_t migrateToChatId;
/**
- * Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated
+ * @brief Optional. In case of exceeding flood control, the number of seconds left to wait before the request can be repeated
*/
int32_t retryAfter;
};
diff --git a/include/tgbot/types/Sticker.h b/include/tgbot/types/Sticker.h
index b7c746b..46ef41d 100644
--- a/include/tgbot/types/Sticker.h
+++ b/include/tgbot/types/Sticker.h
@@ -32,7 +32,8 @@
namespace TgBot {
/**
- * This object represents a general file (as opposed to photos and audio files).
+ * @brief This object represents a general file (as opposed to photos and audio files).
+ *
* @ingroup types
*/
class Sticker {
@@ -41,42 +42,42 @@ public:
typedef std::shared_ptr<Sticker> Ptr;
/**
- * Unique file identifier.
+ * @brief Unique file identifier.
*/
std::string fileId;
/**
- * Optional. Sticker width.
+ * @brief Optional. Sticker width.
*/
int32_t width;
/**
- * Optional. Sticker height.
+ * @brief Optional. Sticker height.
*/
int32_t height;
/**
- * Optional. Optional. Sticker thumbnail in .webp or .jpg format.
+ * @brief Optional. Optional. Sticker thumbnail in .webp or .jpg format.
*/
PhotoSize::Ptr thumb;
/**
- * Optional. Emoji associated with the sticker
+ * @brief Optional. Emoji associated with the sticker
*/
std::string emoji;
/**
- * Optional. Name of the sticker set to which the sticker belongs.
+ * @brief Optional. Name of the sticker set to which the sticker belongs.
*/
std::string setName;
/**
- * Optional. For mask stickers, the position where the mask should be placed.
+ * @brief Optional. For mask stickers, the position where the mask should be placed.
*/
MaskPosition::Ptr maskPosition;
/**
- * Optional. File size.
+ * @brief Optional. File size.
*/
int32_t fileSize;
};
diff --git a/include/tgbot/types/StickerSet.h b/include/tgbot/types/StickerSet.h
index d36c6f1..aaa9496 100644
--- a/include/tgbot/types/StickerSet.h
+++ b/include/tgbot/types/StickerSet.h
@@ -33,7 +33,8 @@
namespace TgBot {
/**
- * This object represents a sticker set.
+ * @brief This object represents a sticker set.
+ *
* @ingroup types
*/
class StickerSet {
@@ -41,22 +42,22 @@ public:
typedef std::shared_ptr<StickerSet> Ptr;
/**
- * Sticker set name.
+ * @brief Sticker set name.
*/
std::string name;
/**
- * Sticker set title.
+ * @brief Sticker set title.
*/
std::string title;
/**
- * True, if the sticker set contains masks.
+ * @brief True, if the sticker set contains masks.
*/
bool containsMasks = false;
/**
- * List of all set stickers.
+ * @brief List of all set stickers.
*/
std::vector<Sticker::Ptr> stickers;
};
diff --git a/include/tgbot/types/Update.h b/include/tgbot/types/Update.h
index 53fe697..61111b5 100644
--- a/include/tgbot/types/Update.h
+++ b/include/tgbot/types/Update.h
@@ -33,7 +33,8 @@
namespace TgBot {
/**
- * This object represents an incoming update.
+ * @brief This object represents an incoming update.
+ *
* @ingroup types
*/
class Update {
@@ -42,42 +43,42 @@ public:
typedef std::shared_ptr<Update> Ptr;
/**
- * The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order.
+ * @brief The update‘s unique identifier. Update identifiers start from a certain positive number and increase sequentially. This ID becomes especially handy if you’re using Webhooks, since it allows you to ignore repeated updates or to restore the correct update sequence, should they get out of order.
*/
int32_t updateId;
/**
- * Optional. New incoming message of any kind — text, photo, sticker, etc.
+ * @brief Optional. New incoming message of any kind — text, photo, sticker, etc.
*/
Message::Ptr message;
/**
- * Optional. New version of a message that is known to the bot and was edited
+ * @brief Optional. New version of a message that is known to the bot and was edited
*/
Message::Ptr editedMessage;
/**
- * Optional. New incoming channel post of any kind — text, photo, sticker, etc.
+ * @brief Optional. New incoming channel post of any kind — text, photo, sticker, etc.
*/
Message::Ptr channelPost;
/**
- * Optional. New version of a channel post that is known to the bot and was edited
+ * @brief Optional. New version of a channel post that is known to the bot and was edited
*/
Message::Ptr editedChannelPost;
/**
- * Optional. New incoming inline query
+ * @brief Optional. New incoming inline query
*/
InlineQuery::Ptr inlineQuery;
/**
- * Optional. The result of an inline query that was chosen by a user and sent to their chat partner.
+ * @brief Optional. The result of an inline query that was chosen by a user and sent to their chat partner.
*/
ChosenInlineResult::Ptr chosenInlineResult;
/**
- * Optional. New incoming callback query.
+ * @brief Optional. New incoming callback query.
*/
CallbackQuery::Ptr callbackQuery;
};
diff --git a/include/tgbot/types/User.h b/include/tgbot/types/User.h
index 7ee7da6..10a80dd 100644
--- a/include/tgbot/types/User.h
+++ b/include/tgbot/types/User.h
@@ -29,7 +29,8 @@
namespace TgBot {
/**
- * This object represents a Telegram user or bot.
+ * @brief This object represents a Telegram user or bot.
+ *
* @ingroup types
*/
class User {
@@ -38,32 +39,32 @@ public:
typedef std::shared_ptr<User> Ptr;
/**
- * Unique identifier for this user or bot.
+ * @brief Unique identifier for this user or bot.
*/
int32_t id;
/**
- * True, if this user is a bot
+ * @brief True, if this user is a bot
*/
bool isBot = false;
/**
- * User‘s or bot’s first name.
+ * @brief User‘s or bot’s first name.
*/
std::string firstName;
/**
- * Optional. User‘s or bot’s last name.
+ * @brief Optional. User‘s or bot’s last name.
*/
std::string lastName;
/**
- * Optional. User‘s or bot’s username.
+ * @brief Optional. User‘s or bot’s username.
*/
std::string username;
/**
- * Optional. IETF language tag of the user's language.
+ * @brief Optional. IETF language tag of the user's language.
*/
std::string languageCode;
};
diff --git a/include/tgbot/types/UserProfilePhotos.h b/include/tgbot/types/UserProfilePhotos.h
index 7c5781d..25cacd9 100644
--- a/include/tgbot/types/UserProfilePhotos.h
+++ b/include/tgbot/types/UserProfilePhotos.h
@@ -31,7 +31,8 @@
namespace TgBot {
/**
- * This object represent a user's profile pictures.
+ * @brief This object represent a user's profile pictures.
+ *
* @ingroup types
*/
class UserProfilePhotos {
@@ -40,12 +41,12 @@ public:
typedef std::shared_ptr<UserProfilePhotos> Ptr;
/**
- * Total number of profile pictures the target user has.
+ * @brief Total number of profile pictures the target user has.
*/
int32_t totalCount;
/**
- * Requested profile pictures (in up to 4 sizes each).
+ * @brief Requested profile pictures (in up to 4 sizes each).
*/
std::vector<std::vector<PhotoSize::Ptr>> photos;
};
diff --git a/include/tgbot/types/Venue.h b/include/tgbot/types/Venue.h
index 5040cce..7e8ada6 100644
--- a/include/tgbot/types/Venue.h
+++ b/include/tgbot/types/Venue.h
@@ -13,7 +13,8 @@
namespace TgBot {
/**
- * This object represents a venue.
+ * @brief This object represents a venue.
+ *
* @ingroup types
*/
class Venue {
@@ -21,22 +22,22 @@ public:
typedef std::shared_ptr<Venue> Ptr;
/**
- * Venue location.
+ * @brief Venue location.
*/
Location::Ptr location;
/**
- * Name of the venue.
+ * @brief Name of the venue.
*/
std::string title;
/**
- * Address of the venue.
+ * @brief Address of the venue.
*/
std::string address;
/**
- * Optional. Foursquare identifier of the venue.
+ * @brief Optional. Foursquare identifier of the venue.
*/
std::string foursquare_id;
};
diff --git a/include/tgbot/types/Video.h b/include/tgbot/types/Video.h
index b20d914..e491aac 100644
--- a/include/tgbot/types/Video.h
+++ b/include/tgbot/types/Video.h
@@ -31,7 +31,8 @@
namespace TgBot {
/**
- * This object represents a video file.
+ * @brief This object represents a video file.
+ *
* @ingroup types
*/
class Video {
@@ -40,37 +41,37 @@ public:
typedef std::shared_ptr<Video> Ptr;
/**
- * Unique identifier for this file.
+ * @brief Unique identifier for this file.
*/
std::string fileId;
/**
- * Video width as defined by sender.
+ * @brief Video width as defined by sender.
*/
int32_t width;
/**
- * Video height as defined by sender.
+ * @brief Video height as defined by sender.
*/
int32_t height;
/**
- * Duration of the video in seconds as defined by sender.
+ * @brief Duration of the video in seconds as defined by sender.
*/
int32_t duration;
/**
- * Optional. Video thumbnail.
+ * @brief Optional. Video thumbnail.
*/
PhotoSize::Ptr thumb;
/**
- * Optional. Mime type of a file as defined by sender
+ * @brief Optional. Mime type of a file as defined by sender
*/
std::string mimeType;
/**
- * Optional. File size.
+ * @brief Optional. File size.
*/
int32_t fileSize;
};
diff --git a/include/tgbot/types/VideoNote.h b/include/tgbot/types/VideoNote.h
index bff452e..0e879ad 100644
--- a/include/tgbot/types/VideoNote.h
+++ b/include/tgbot/types/VideoNote.h
@@ -31,7 +31,8 @@
namespace TgBot {
/**
- * This object represents a video message (available in Telegram apps as of v.4.0).
+ * @brief This object represents a video message (available in Telegram apps as of v.4.0).
+ *
* @ingroup types
*/
class VideoNote {
@@ -40,27 +41,27 @@ public:
typedef std::shared_ptr<VideoNote> Ptr;
/**
- * Unique identifier for this file.
+ * @brief Unique identifier for this file.
*/
std::string fileId;
/**
- * Video width and height as defined by sender.
+ * @brief Video width and height as defined by sender.
*/
int32_t length;
/**
- * Duration of the video in seconds as defined by sender.
+ * @brief Duration of the video in seconds as defined by sender.
*/
int32_t duration;
/**
- * Optional. Video thumbnail.
+ * @brief Optional. Video thumbnail.
*/
PhotoSize::Ptr thumb;
/**
- * Optional. File size.
+ * @brief Optional. File size.
*/
int32_t fileSize;
};
diff --git a/include/tgbot/types/Voice.h b/include/tgbot/types/Voice.h
index b148a50..397f5b0 100644
--- a/include/tgbot/types/Voice.h
+++ b/include/tgbot/types/Voice.h
@@ -11,7 +11,8 @@
namespace TgBot {
/**
- * This object represents a voice note.
+ * @brief This object represents a voice note.
+ *
* @ingroup types
*/
class Voice {
@@ -19,22 +20,22 @@ public:
typedef std::shared_ptr<Voice> Ptr;
/**
- * Unique identifier for this file.
+ * @brief Unique identifier for this file.
*/
std::string file_id;
/**
- * Duration of the audio in seconds as defined by sender.
+ * @brief Duration of the audio in seconds as defined by sender.
*/
int32_t duration;
/**
- * Optional. MIME type of the file as defined by sender;
+ * @brief Optional. MIME type of the file as defined by sender;
*/
std::string mime_type;
/**
- * Optional. File size.
+ * @brief Optional. File size.
*/
int32_t file_size;
};
diff --git a/include/tgbot/types/WebhookInfo.h b/include/tgbot/types/WebhookInfo.h
index f08e4ac..9bea884 100644
--- a/include/tgbot/types/WebhookInfo.h
+++ b/include/tgbot/types/WebhookInfo.h
@@ -12,7 +12,8 @@
namespace TgBot {
/**
- * Contains information about the current status of a webhook.
+ * @brief Contains information about the current status of a webhook.
+ *
* @ingroup types
*/
class WebhookInfo {
@@ -20,37 +21,37 @@ public:
typedef std::shared_ptr<WebhookInfo> Ptr;
/**
- * Webhook URL, may be empty if webhook is not set up.
+ * @brief Webhook URL, may be empty if webhook is not set up.
*/
std::string url;
/**
- * True, if a custom certificate was provided for webhook certificate checks
+ * @brief True, if a custom certificate was provided for webhook certificate checks
*/
bool hasCustomCertificate;
/**
- * Number of updates awaiting delivery
+ * @brief Number of updates awaiting delivery
*/
int32_t pendingUpdateCount;
/**
- * Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook
+ * @brief Optional. Unix time for the most recent error that happened when trying to deliver an update via webhook
*/
int32_t lastErrorDate;
/**
- * Optional. Error message in human - readable format for the most recent error that happened when trying to deliver an update via webhook
+ * @brief Optional. Error message in human - readable format for the most recent error that happened when trying to deliver an update via webhook
*/
std::string lastErrorMessage;
/**
- * Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery
+ * @brief Optional. Maximum allowed number of simultaneous HTTPS connections to the webhook for update delivery
*/
int32_t maxConnections;
/**
- * Optional. A list of update types the bot is subscribed to. Defaults to all update types
+ * @brief Optional. A list of update types the bot is subscribed to. Defaults to all update types
*/
std::vector<std::string> allowedUpdates;
};