summaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorOleg Morozenkov <omorozenkov@gmail.com>2015-09-15 18:18:49 +0300
committerOleg Morozenkov <omorozenkov@gmail.com>2015-09-15 18:18:49 +0300
commit6a3c8387da208ac2ffa4757dfafe1600a693b24f (patch)
treea8cfbfd46643784ede5ddfc0ce6dcd5f39d533d2 /include
parent370df9853702bf9666b8dfa2e4254b9e236b2789 (diff)
Fix formatting + some minor improvements
Diffstat (limited to 'include')
-rw-r--r--include/tgbot/Api.h20
-rw-r--r--include/tgbot/net/HttpReqArg.h12
-rw-r--r--include/tgbot/net/TgWebhookLocalServer.h6
-rw-r--r--include/tgbot/types/GenericChat.h2
-rw-r--r--include/tgbot/types/InputFile.h12
5 files changed, 25 insertions, 27 deletions
diff --git a/include/tgbot/Api.h b/include/tgbot/Api.h
index 1881015..0d32252 100644
--- a/include/tgbot/Api.h
+++ b/include/tgbot/Api.h
@@ -91,13 +91,13 @@ public:
/**
* Use this method to send photos.
* @param chatId Unique identifier for the message recipient — User or GroupChat id.
- * @param photo Photo to send. Id of the photo that is already on the Telegram servers.
+ * @param photoId Id of the photo that is already on the Telegram servers.
* @param caption Optional. Photo caption.
* @param replyToMessageId Optional. If the message is a reply, ID of the original message.
* @param replyMarkup Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
* @return On success, the sent message is returned.
*/
- Message::Ptr sendPhoto(int32_t chatId, const std::string& photoId, const std::string& caption = "", int32_t replyToMessageId = 0, const GenericReply::Ptr& replyMarkup = GenericReply::Ptr()) const;
+ Message::Ptr sendPhoto(int32_t chatId, const std::string& photoId, const std::string& caption = "", int32_t replyToMessageId = 0, const GenericReply::Ptr& replyMarkup = GenericReply::Ptr()) 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).
@@ -113,13 +113,13 @@ public:
/**
* 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 message recipient — User or GroupChat id.
- * @param audio Id of the audio that is already on the Telegram servers.
+ * @param audioId Id of the audio that is already on the Telegram servers.
* @param duration Duration of sent audio in seconds.
* @param replyToMessageId Optional. If the message is a reply, ID of the original message.
* @param replyMarkup Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
* @return On success, the sent message is returned.
*/
- Message::Ptr sendAudio(int32_t chatId, const std::string& audioId, int32_t duration = 0, int32_t replyToMessageId = 0, const GenericReply::Ptr& replyMarkup = GenericReply::Ptr()) const;
+ Message::Ptr sendAudio(int32_t chatId, const std::string& audioId, int32_t duration = 0, int32_t replyToMessageId = 0, const GenericReply::Ptr& replyMarkup = GenericReply::Ptr()) const;
/**
* Use this method to send general files.
@@ -134,12 +134,12 @@ public:
/**
* Use this method to send general files.
* @param chatId Unique identifier for the message recipient — User or GroupChat id.
- * @param document Id of the document that is already on the Telegram servers.
+ * @param documentId Id of the document that is already on the Telegram servers.
* @param replyToMessageId Optional. If the message is a reply, ID of the original message.
* @param replyMarkup Optional. Additional interface options. An object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
* @return On success, the sent message is returned.
*/
- Message::Ptr sendDocument(int32_t chatId, const std::string& documentId, int32_t replyToMessageId = 0, const GenericReply::Ptr& replyMarkup = GenericReply::Ptr()) const;
+ Message::Ptr sendDocument(int32_t chatId, const std::string& documentId, int32_t replyToMessageId = 0, const GenericReply::Ptr& replyMarkup = GenericReply::Ptr()) const;
/**
* Use this method to send .webp stickers.
@@ -154,12 +154,12 @@ public:
/**
* Use this method to send .webp stickers.
* @param chatId Unique identifier for the message recipient — User or GroupChat id.
- * @param sticker Id of the sticker that is already on the Telegram servers.
+ * @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.
* @param replyMarkup Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
* @return On success, the sent message is returned.
*/
- Message::Ptr sendSticker(int32_t chatId, const std::string& stickerId, int32_t replyToMessageId = 0, const GenericReply::Ptr& replyMarkup = GenericReply::Ptr()) const;
+ Message::Ptr sendSticker(int32_t chatId, const std::string& stickerId, int32_t replyToMessageId = 0, const GenericReply::Ptr& replyMarkup = GenericReply::Ptr()) const;
/**
* Use this method to send video files, Telegram clients support mp4 videos (other formats may be sent as Document).
@@ -174,12 +174,12 @@ public:
/**
* 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 message recipient — User or GroupChat id.
- * @param video Id of the video that is already on the Telegram servers.
+ * @param videoId Id of the video that is already on the Telegram servers.
* @param replyToMessageId Optional. If the message is a reply, ID of the original message.
* @param replyMarkup Optional. Additional interface options. A object for a custom reply keyboard, instructions to hide keyboard or to force a reply from the user.
* @return On success, the sent message is returned.
*/
- Message::Ptr sendVideo(int32_t chatId, const std::string& videoId, int32_t replyToMessageId = 0, const GenericReply::Ptr& replyMarkup = GenericReply::Ptr()) const;
+ Message::Ptr sendVideo(int32_t chatId, const std::string& videoId, int32_t replyToMessageId = 0, const GenericReply::Ptr& replyMarkup = GenericReply::Ptr()) const;
/**
* Use this method to send point on the map.
diff --git a/include/tgbot/net/HttpReqArg.h b/include/tgbot/net/HttpReqArg.h
index 683c2b0..f0e4492 100644
--- a/include/tgbot/net/HttpReqArg.h
+++ b/include/tgbot/net/HttpReqArg.h
@@ -37,8 +37,8 @@ class HttpReqArg {
public:
template<typename T>
- HttpReqArg(const std::string& name, const T& value, bool isFile = false, const std::string& mimeType = "text/plain", std::string fileName = "") :
- name(name), value(boost::lexical_cast<std::string>(value)), isFile(isFile), mimeType(mimeType), fileName(fileName)
+ HttpReqArg(const std::string& name, const T& value, bool isFile = false, const std::string& mimeType = "text/plain", const std::string& fileName = "") :
+ name(name), value(boost::lexical_cast<std::string>(value)), isFile(isFile), mimeType(mimeType), fileName(fileName)
{
}
@@ -62,10 +62,10 @@ public:
*/
std::string mimeType = "text/plain";
- /**
- * Should be set if an argument value hold some file contents
- */
- std::string fileName;
+ /**
+ * Should be set if an argument value hold some file contents
+ */
+ std::string fileName;
};
}
diff --git a/include/tgbot/net/TgWebhookLocalServer.h b/include/tgbot/net/TgWebhookLocalServer.h
index 770c66c..67268f5 100644
--- a/include/tgbot/net/TgWebhookLocalServer.h
+++ b/include/tgbot/net/TgWebhookLocalServer.h
@@ -23,7 +23,7 @@
#ifndef TGBOT_TGWEBHOOKTCPSERVER_H
#define TGBOT_TGWEBHOOKTCPSERVER_H
-# ifdef BOOST_ASIO_HAS_LOCAL_SOCKETS
+#ifdef BOOST_ASIO_HAS_LOCAL_SOCKETS
#include "tgbot/net/TgWebhookServer.h"
@@ -48,5 +48,7 @@ public:
};
}
-# endif
+
+#endif //BOOST_ASIO_HAS_LOCAL_SOCKETS
+
#endif //TGBOT_TGWEBHOOKTCPSERVER_H
diff --git a/include/tgbot/types/GenericChat.h b/include/tgbot/types/GenericChat.h
index f1fe6a1..2d91281 100644
--- a/include/tgbot/types/GenericChat.h
+++ b/include/tgbot/types/GenericChat.h
@@ -39,7 +39,7 @@ public:
virtual ~GenericChat() { }
/**
- * Unique identifier for this user, bot or group chat
+ * Unique identifier for this user, bot or group chat
*/
int32_t id;
};
diff --git a/include/tgbot/types/InputFile.h b/include/tgbot/types/InputFile.h
index 1228885..f2403e3 100644
--- a/include/tgbot/types/InputFile.h
+++ b/include/tgbot/types/InputFile.h
@@ -36,10 +36,6 @@ namespace TgBot {
class InputFile {
public:
- InputFile() {
- fileName = "set_file_name.ext";
- }
-
typedef std::shared_ptr<InputFile> Ptr;
/**
@@ -52,10 +48,10 @@ public:
*/
std::string mimeType;
- /**
- * File name.
- */
- std::string fileName;
+ /**
+ * File name.
+ */
+ std::string fileName;
};
}