Mercurial > hg > openttd
changeset 6830:8a349f3bf427 draft
(svn r10069) -Documentation: some documentation for TIC/TOC, as it isn't what I expected...
author | truelight <truelight@openttd.org> |
---|---|
date | Fri, 08 Jun 2007 18:23:26 +0000 |
parents | 7b96a3eb93ba |
children | bfec3bac46a7 |
files | src/debug.h |
diffstat | 1 files changed, 21 insertions(+), 1 deletions(-) [+] |
line wrap: on
line diff
--- a/src/debug.h +++ b/src/debug.h @@ -93,7 +93,27 @@ #define OTTD_PRINTF64 "ll" #endif -/* Used for profiling */ +/* Used for profiling + * + * Usage: + * TIC(); + * --Do your code-- + * TOC("A name", 1); + * + * When you run the TIC() / TOC() multiple times, you can increase the '1' + * to only display average stats every N values. Some things to know: + * + * for (int i = 0; i < 5; i++) { + * TIC(); + * --Do yuor code-- + * TOC("A name", 5); + * } + * + * Is the correct usage for multiple TIC() / TOC() calls. + * + * TIC() / TOC() creates it's own block, so make sure not the mangle + * it with an other block. + **/ #define TIC() {\ extern uint64 _rdtsc();\ uint64 _xxx_ = _rdtsc();\