Browse Source

* fix doxygen warnings

pull/509/merge
hagen 9 years ago
parent
commit
c9836cf0f7
  1. 4
      Config.h
  2. 16
      HTTP.h
  3. 2
      Log.cpp
  4. 7
      Log.h

4
Config.h

@ -68,7 +68,7 @@ namespace config { @@ -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 { @@ -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) {

16
HTTP.h

@ -38,7 +38,7 @@ namespace http { @@ -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 { @@ -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 { @@ -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();

2
Log.cpp

@ -12,7 +12,7 @@ namespace i2p { @@ -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] =
{

7
Log.h

@ -86,7 +86,7 @@ namespace log { @@ -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 { @@ -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 { @@ -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.

Loading…
Cancel
Save