From 167dffc05e03533c34b90eced6449b546f6fa351 Mon Sep 17 00:00:00 2001 From: Bader Date: Sun, 15 Oct 2023 11:26:55 +0100 Subject: [PATCH] remove @example doc tags --- include/tgbotxx/Api.hpp | 2 +- include/tgbotxx/objects/ForceReply.hpp | 4 ++-- include/tgbotxx/objects/ReplyKeyboardMarkup.hpp | 2 +- include/tgbotxx/objects/ReplyKeyboardRemove.hpp | 2 +- include/tgbotxx/utils/StringUtils.hpp | 4 ++-- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/include/tgbotxx/Api.hpp b/include/tgbotxx/Api.hpp index d5e63cc50..06d0dbcd3 100644 --- a/include/tgbotxx/Api.hpp +++ b/include/tgbotxx/Api.hpp @@ -709,7 +709,7 @@ namespace tgbotxx { /// @param messageThreadId Optional. Unique identifier for the target message thread (topic) of the forum; for forum supergroups only /// @returns True on success. /// @throws Exception on failure - /// @example Example: The ImageBot needs some time to process a request and upload the image. https://t.me/imagebot + /// Example: The ImageBot needs some time to process a request and upload the image. https://t.me/imagebot /// 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. /// @note We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive. diff --git a/include/tgbotxx/objects/ForceReply.hpp b/include/tgbotxx/objects/ForceReply.hpp index 43e5e7b33..cda702629 100644 --- a/include/tgbotxx/objects/ForceReply.hpp +++ b/include/tgbotxx/objects/ForceReply.hpp @@ -6,7 +6,7 @@ namespace tgbotxx { /// 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. /// https://core.telegram.org/bots/features#privacy-mode - /// @example Example: A poll bot for groups runs in privacy mode (only receives commands, replies to its messages and mentions). + /// 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'. @@ -22,7 +22,7 @@ namespace tgbotxx { bool forceReply{}; /// @brief Optional. The placeholder to be shown in the input field when the reply is active; 1-64 characters - std::string inputFieldPlaceholder{}; + std::string inputFieldPlaceholder; /// @brief Optional. Use this parameter if you want to force reply from specific users only. /// Targets: diff --git a/include/tgbotxx/objects/ReplyKeyboardMarkup.hpp b/include/tgbotxx/objects/ReplyKeyboardMarkup.hpp index 11d7351a1..27a319fba 100644 --- a/include/tgbotxx/objects/ReplyKeyboardMarkup.hpp +++ b/include/tgbotxx/objects/ReplyKeyboardMarkup.hpp @@ -39,7 +39,7 @@ namespace tgbotxx { /// - 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. + /// 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{}; diff --git a/include/tgbotxx/objects/ReplyKeyboardRemove.hpp b/include/tgbotxx/objects/ReplyKeyboardRemove.hpp index d1f3578fe..b72eb8805 100644 --- a/include/tgbotxx/objects/ReplyKeyboardRemove.hpp +++ b/include/tgbotxx/objects/ReplyKeyboardRemove.hpp @@ -21,7 +21,7 @@ namespace tgbotxx { /// - 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, + /// 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{}; diff --git a/include/tgbotxx/utils/StringUtils.hpp b/include/tgbotxx/utils/StringUtils.hpp index 3dc7d45a8..35f75b9fd 100644 --- a/include/tgbotxx/utils/StringUtils.hpp +++ b/include/tgbotxx/utils/StringUtils.hpp @@ -9,10 +9,10 @@ namespace tgbotxx { /// @brief Namespace contains useful string related utility functions. namespace StringUtils { /// @brief Form a string from a container with a delimiter - /// @example: array = [1,2,3] - /// StringUtils::join(array, ",") -> "1,2,3" /// @param con: Container of T elements /// @param delim: Text to put between each element T + /// Example: array = [1,2,3] + /// StringUtils::join(array, ",") -> "1,2,3" template static std::string join(const std::span& con, const D& delim) { std::ostringstream oss{};