mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

(svn r20784) -Doc: Doxyment a few debug line printing functions.

release/1.1
alberth 2010-09-11 11:48:37 +00:00
parent c0ba81e617
commit dfeac6ba2e
2 changed files with 24 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/debug.cpp
View File

@ -69,6 +69,11 @@ struct DebugLevel {
#if !defined(NO_DEBUG_MESSAGES) #if !defined(NO_DEBUG_MESSAGES)
/**
* Internal function for outputting the debug line.
* @param dbg Debug category.
* @param buf Text line to output.
*/
static void debug_print(const char *dbg, const char *buf) static void debug_print(const char *dbg, const char *buf)
{ {
#if defined(ENABLE_NETWORK) #if defined(ENABLE_NETWORK)
@ -99,6 +104,12 @@ static void debug_print(const char *dbg, const char *buf)
} }
} }
/**
* Output a debug line.
* @note Do not call directly, use the #DEBUG macro instead.
* @param dbg Debug category.
* @param format Text string a la printf, with optional arguments.
*/
void CDECL debug(const char *dbg, const char *format, ...) void CDECL debug(const char *dbg, const char *format, ...)
{ {
char buf[1024]; char buf[1024];
@ -112,6 +123,12 @@ void CDECL debug(const char *dbg, const char *format, ...)
} }
#endif /* NO_DEBUG_MESSAGES */ #endif /* NO_DEBUG_MESSAGES */
/**
* Set debugging levels by parsing the text in \a s.
* For setting individual levels a string like \c "net=3,grf=6" should be used.
* If the string starts with a number, the number is used as global debugging level.
* @param s Text describing the wanted debugging levels.
*/
void SetDebugString(const char *s) void SetDebugString(const char *s)
{ {
int v; int v;
@ -162,8 +179,8 @@ void SetDebugString(const char *s)
} }
/** /**
* Print out the current debug-level * Print out the current debug-level.
* Just return a string with the values of all the debug categorites * Just return a string with the values of all the debug categories.
* @return string with debug-levels * @return string with debug-levels
*/ */
const char *GetDebugString() const char *GetDebugString()

5
src/debug.h
View File

@ -29,6 +29,11 @@
#ifdef NO_DEBUG_MESSAGES #ifdef NO_DEBUG_MESSAGES
#define DEBUG(name, level, ...) { } #define DEBUG(name, level, ...) { }
#else /* NO_DEBUG_MESSAGES */ #else /* NO_DEBUG_MESSAGES */
/**
* Output a line of debugging information.
* @param name Category
* @param level Debugging level, higher levels means more detailed information.
*/
#define DEBUG(name, level, ...) if ((level) == 0 || _debug_ ## name ## _level >= (level)) debug(#name, __VA_ARGS__) #define DEBUG(name, level, ...) if ((level) == 0 || _debug_ ## name ## _level >= (level)) debug(#name, __VA_ARGS__)
extern int _debug_ai_level; extern int _debug_ai_level;