mispelled brief, corrected it

This commit is contained in:
jebes 2014-09-11 10:36:39 -04:00
parent dfed3d39b6
commit f7900ccfc1
2 changed files with 14 additions and 14 deletions

View file

@ -58,7 +58,7 @@ namespace tools
*/ */
std::string get_default_data_dir(); std::string get_default_data_dir();
/*! \breif Returns the OS version string /*! \brief Returns the OS version string
* *
* \details This is a wrapper around the primitives * \details This is a wrapper around the primitives
* get_windows_version_display_string() and * get_windows_version_display_string() and
@ -66,7 +66,7 @@ namespace tools
*/ */
std::string get_os_version_string(); std::string get_os_version_string();
/*! \breif creates directories for a path /*! \brief creates directories for a path
* *
* wrapper around boost::filesyste::create_directories. * wrapper around boost::filesyste::create_directories.
* (ensure-directory-exists): greenspun's tenth rule in action! * (ensure-directory-exists): greenspun's tenth rule in action!
@ -84,7 +84,7 @@ namespace tools
return crypto::cn_fast_hash(s.data(), s.size()); return crypto::cn_fast_hash(s.data(), s.size());
} }
/*! \breif Defines a signal handler for win32 and *nix /*! \brief Defines a signal handler for win32 and *nix
*/ */
class signal_handler class signal_handler
{ {
@ -111,7 +111,7 @@ namespace tools
private: private:
#if defined(WIN32) #if defined(WIN32)
/*! \breif Handler for win */ /*! \brief Handler for win */
static BOOL WINAPI win_handler(DWORD type) static BOOL WINAPI win_handler(DWORD type)
{ {
if (CTRL_C_EVENT == type || CTRL_BREAK_EVENT == type) if (CTRL_C_EVENT == type || CTRL_BREAK_EVENT == type)
@ -126,14 +126,14 @@ namespace tools
return TRUE; return TRUE;
} }
#else #else
/*! \breif handler for NIX */ /*! \brief handler for NIX */
static void posix_handler(int /*type*/) static void posix_handler(int /*type*/)
{ {
handle_signal(); handle_signal();
} }
#endif #endif
/*! \breif calles m_handler */ /*! \brief calles m_handler */
static void handle_signal() static void handle_signal()
{ {
static std::mutex m_mutex; static std::mutex m_mutex;
@ -141,7 +141,7 @@ namespace tools
m_handler(); m_handler();
} }
/*! \breif where the installed handler is stored */ /*! \brief where the installed handler is stored */
static std::function<void(void)> m_handler; static std::function<void(void)> m_handler;
}; };
} }

View file

@ -52,16 +52,16 @@
namespace tools { namespace tools {
/*! \breif Error codes for varint /*! \brief Error codes for varint
*/ */
enum { enum {
/* \breif Represents the overflow error */ /* \brief Represents the overflow error */
EVARINT_OVERFLOW = -1, EVARINT_OVERFLOW = -1,
/* \breif Represents a non conical represnetation */ /* \brief Represents a non conical represnetation */
EVARINT_REPRESENT = -2, EVARINT_REPRESENT = -2,
}; };
/*! \breif writes a varint to a stream. /*! \brief writes a varint to a stream.
*/ */
template<typename OutputIt, typename T> template<typename OutputIt, typename T>
/* Requires T to be both an integral type and unsigned, should be a compile error if it is not */ /* Requires T to be both an integral type and unsigned, should be a compile error if it is not */
@ -78,7 +78,7 @@ namespace tools {
dest++; /* Seems kinda pointless... */ dest++; /* Seems kinda pointless... */
} }
/*! \breif Returns the string that represents the varint /*! \brief Returns the string that represents the varint
*/ */
template<typename T> template<typename T>
std::string get_varint_data(const T& v) std::string get_varint_data(const T& v)
@ -87,7 +87,7 @@ namespace tools {
write_varint(std::ostreambuf_iterator<char>(ss), v); write_varint(std::ostreambuf_iterator<char>(ss), v);
return ss.str(); return ss.str();
} }
/*! \breif reads in the varint as pointer to by InputIt into i /*! \brief reads in the varint as pointer to by InputIt into i
*/ */
template<int bits, typename InputIt, typename T> template<int bits, typename InputIt, typename T>
typename std::enable_if<std::is_integral<T>::value && std::is_unsigned<T>::value && 0 <= bits && bits <= std::numeric_limits<T>::digits, int>::type typename std::enable_if<std::is_integral<T>::value && std::is_unsigned<T>::value && 0 <= bits && bits <= std::numeric_limits<T>::digits, int>::type
@ -118,7 +118,7 @@ namespace tools {
return read; return read;
} }
/*! \breif Wrapper around the other read_varint, /*! \brief Wrapper around the other read_varint,
* Sets template parameters for you. * Sets template parameters for you.
*/ */
template<typename InputIt, typename T> template<typename InputIt, typename T>