pyrit: comparison include/common.h

equal deleted inserted replaced

-:2a853d284a6a
+:64638385798a
 #define NORETURN __declspec(noreturn)
 #else
 #define NORETURN __attribute__((noreturn))
 #endif
-/* verbosity level:
+/**
-0: only errors and warnings (E, W)
+* verbosity level
-1: major status messages (*)
+*
-2: minor status, progress (-)
+* - 0: only errors and warnings (E, W)
-3: debug messages (D)
+* - 1: major status messages (*)
-4: thread debug
+* - 2: minor status, progress (-)
-default = 2
+* - 3: debug messages (D)
-*/
+* - 4: thread debug
+*
+* default is 2
+*/
 extern int pyrit_verbosity;
+/**
+* print status or debugging message
+* @param[in] vlevel    verbosity level of the message
+* @see pyrit_verbosity
+*/
 void dbgmsg(const int vlevel, const char *format, ...);
+/** template for minimum of three numbers */
 template<typename Type> const Type &min3(const Type &a, const Type &b, const Type &c)
 {
 	if (a <= b)
 	{
 		if (a <= c)
 		else
 			return c;
 	}
 }
+/** template for maximum of three numbers */
 template<typename Type> const Type &max3(const Type &a, const Type &b, const Type &c)
 {
 	if (a >= b)
 	{
 		if (a >= c)
 		else
 			return c;
 	}
 }
+/** trim whitespace from beginning and end of string */
 inline void trim(string& s)
 {
 	const char *ws = " \n";
 	string::size_type pos = s.find_last_not_of(ws);
 	if (pos != string::npos)