Skip to content

Commit

Permalink
remove @example doc tags
Browse files Browse the repository at this point in the history
  • Loading branch information
baderouaich committed Oct 15, 2023
1 parent ea9d708 commit 167dffc
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion include/tgbotxx/Api.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions include/tgbotxx/objects/ForceReply.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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'.
Expand All @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion include/tgbotxx/objects/ReplyKeyboardMarkup.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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{};

Expand Down
2 changes: 1 addition & 1 deletion include/tgbotxx/objects/ReplyKeyboardRemove.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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{};

Expand Down
4 changes: 2 additions & 2 deletions include/tgbotxx/utils/StringUtils.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -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<typename T, typename D>
static std::string join(const std::span<T>& con, const D& delim) {
std::ostringstream oss{};
Expand Down

0 comments on commit 167dffc

Please sign in to comment.