Added @brief to the Doxygen comment.

6 files changed, 28 insertions, 21 deletions

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;
 };