From c9836cf0f787c7ee8a0b3553653b80148299becb Mon Sep 17 00:00:00 2001
From: hagen <hagen@mail.i2p>
Date: Tue, 31 May 2016 00:00:00 +0000
Subject: [PATCH] * fix doxygen warnings

---
 Config.h |  4 ++--
 HTTP.h   | 16 +++++++++-------
 Log.cpp  |  2 +-
 Log.h    |  7 ++++---
 4 files changed, 16 insertions(+), 13 deletions(-)

diff --git a/Config.h b/Config.h
index d79a9c47..6b2af717 100644
--- a/Config.h
+++ b/Config.h
@@ -68,7 +68,7 @@ namespace config {
    * @param  value Variable where to store option
    * @return this function returns false if parameter not found
    *
-   * @example  uint16_t port; GetOption("sam.port", port);
+   * Example: uint16_t port; GetOption("sam.port", port);
    */
   template<typename T>
   bool GetOption(const char *name, T& value) {
@@ -84,7 +84,7 @@ namespace config {
    * @param  value New parameter value
    * @return true if value set up successful, false otherwise
    *
-   * @example uint16_t port = 2827; SetOption("bob.port", port);
+   * Example: uint16_t port = 2827; SetOption("bob.port", port);
    */
   template<typename T>
   bool SetOption(const char *name, const T& value) {
diff --git a/HTTP.h b/HTTP.h
index f227271f..8d10c231 100644
--- a/HTTP.h
+++ b/HTTP.h
@@ -38,7 +38,7 @@ namespace http {
      * @brief Tries to parse url from string
      * @return true on success, false on invalid url
      */
-    bool parse (const char *str, size_t len = 0);
+    bool parse (const char *str, std::size_t len = 0);
     bool parse (const std::string& url);
 
     /**
@@ -89,10 +89,12 @@ namespace http {
     std::string version;
     std::string status;
     unsigned short int code;
-    /** simplifies response generation
-     * If this variable is set:
-     * a) Content-Length header will be added if missing
-     * b) contents of body will be included in response
+    /**
+     * @brief Simplifies response generation
+     *
+     * If this variable is set, on @a to_string() call:
+     *   * Content-Length header will be added if missing,
+     *   * contents of @a body will be included in generated response
      */
     std::string body;
 
@@ -108,9 +110,9 @@ namespace http {
 
     /**
      * @brief Serialize HTTP response to string
-     * @note If version is set to HTTP/1.1, and Date header is missing,
+     * @note If @a version is set to HTTP/1.1, and Date header is missing,
      *   it will be generated based on current time and added to headers
-     * @note If body member is set and Content-Length header is missing,
+     * @note If @a body is set and Content-Length header is missing,
      *   this header will be added, based on body's length
      */
     std::string to_string();
diff --git a/Log.cpp b/Log.cpp
index 155efbe8..590f3d0f 100644
--- a/Log.cpp
+++ b/Log.cpp
@@ -12,7 +12,7 @@ namespace i2p {
 namespace log {
 	Log logger;
 	/**
-	 * @enum Maps our loglevel to their symbolic name
+	 * @brief Maps our loglevel to their symbolic name
 	 */
 	static const char * g_LogLevelStr[eNumLogLevels] =
 	{
diff --git a/Log.h b/Log.h
index 33bd5868..6762899f 100644
--- a/Log.h
+++ b/Log.h
@@ -86,7 +86,7 @@ namespace log {
 			LogLevel GetLogLevel () { return m_MinLevel; };
 
 			/**
-			 * @brief  Sets minimal alloed level for log messages
+			 * @brief  Sets minimal allowed level for log messages
 			 * @param  level  String with wanted minimal msg level
 			 */
 			void     SetLogLevel (const std::string& level);
@@ -101,7 +101,7 @@ namespace log {
 			 * @brief Sets log destination to given output stream
 			 * @param os  Output stream
 			 */
-			void SendTo (std::shared_ptr<std::ostream> s);
+			void SendTo (std::shared_ptr<std::ostream> os);
 
 	#ifndef _WIN32
 			/**
@@ -129,7 +129,8 @@ namespace log {
 	};
 
 	/**
-	 * @struct Log message container
+	 * @struct LogMsg
+	 * @brief Log message container
 	 *
 	 * We creating it somewhere with LogPrint(),
 	 * then put in MsgQueue for later processing.