summaryrefslogtreecommitdiff
path: root/src/macros.h
diff options
context:
space:
mode:
authorbelugas <belugas@openttd.org>2007-03-03 04:04:22 +0000
committerbelugas <belugas@openttd.org>2007-03-03 04:04:22 +0000
commit5792aa85c7b39efbba313659c287abd9ae66df88 (patch)
treea56d1e1d13bc7d618e33a50ed711f4c5387a5c21 /src/macros.h
parent502ec1b6721832b170bd133480ec785b2cd1d5a7 (diff)
downloadopenttd-5792aa85c7b39efbba313659c287abd9ae66df88.tar.xz
(svn r8987) -Cleanup: doxygen changes. Again. Mostly (still) @files missing tags and (more than just) a few comments style.
Diffstat (limited to 'src/macros.h')
-rw-r--r--src/macros.h10
1 files changed, 6 insertions, 4 deletions
diff --git a/src/macros.h b/src/macros.h
index 00ef5af65..35964c07b 100644
--- a/src/macros.h
+++ b/src/macros.h
@@ -1,13 +1,15 @@
/* $Id$ */
+/** @file macros.h */
+
#ifndef MACROS_H
#define MACROS_H
-/// Fetch n bits starting at bit s from x
+/* Fetch n bits starting at bit s from x */
#define GB(x, s, n) (((x) >> (s)) & ((1U << (n)) - 1))
-/// Set n bits starting at bit s in x to d
+/* Set n bits starting at bit s in x to d */
#define SB(x, s, n, d) ((x) = ((x) & ~(((1U << (n)) - 1) << (s))) | ((d) << (s)))
-/// Add i to the n bits starting at bit s in x
+/* Add i to the n bits starting at bit s in x */
#define AB(x, s, n, i) ((x) = ((x) & ~(((1U << (n)) - 1) << (s))) | (((x) + ((i) << (s))) & (((1U << (n)) - 1) << (s))))
#ifdef min
@@ -79,7 +81,7 @@ template<typename T> static inline T TOGGLEBIT(T& x, int y)
}
-// checking more bits. Maybe unneccessary, but easy to use
+/* checking more bits. Maybe unneccessary, but easy to use */
#define HASBITS(x,y) ((x) & (y))
#define SETBITS(x,y) ((x) |= (y))
#define CLRBITS(x,y) ((x) &= ~(y))