base: Tag API methods in condcodes.hh
Change-Id: Ife6b5ed6ee684b65790c374ab6e709ce8eb708ad
Signed-off-by: Hoa Nguyen <hoanguyen@ucdavis.edu>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/33074
Reviewed-by: Bobby R. Bruce <bbruce@ucdavis.edu>
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Maintainer: Bobby R. Bruce <bbruce@ucdavis.edu>
Tested-by: kokoro <noreply+kokoro@google.com>
diff --git a/src/base/condcodes.hh b/src/base/condcodes.hh
index 5de2daa..b15fec0 100644
--- a/src/base/condcodes.hh
+++ b/src/base/condcodes.hh
@@ -74,6 +74,8 @@
* If we have a carry in, but no carry out:
* src1 and src2 can neither be 1. So the overall result bit is 1. Hence:
* ~1 + 0 + 0 => 0. We return false.
+ *
+ * @ingroup api_base_utils
*/
static inline bool
findCarry(int width, uint64_t dest, uint64_t src1, uint64_t src2)
@@ -86,6 +88,8 @@
/**
* Calculate the overflow flag from an addition.
+ *
+ * @ingroup api_base_utils
*/
static inline bool
findOverflow(int width, uint64_t dest, uint64_t src1, uint64_t src2)
@@ -109,6 +113,8 @@
* If the intermediate is still one, then there is exactly one high bit
* which does not have a corresponding high bit. Therefore, the value must
* have odd parity, and we return 1 accordingly. Otherwise we return 0.
+ *
+ * @ingroup api_base_utils
*/
static inline bool
findParity(int width, uint64_t dest)
@@ -125,6 +131,8 @@
/**
* Calculate the negative flag.
+ *
+ * @ingroup api_base_utils
*/
static inline bool
findNegative(int width, uint64_t dest)
@@ -134,6 +142,8 @@
/**
* Calculate the zero flag.
+ *
+ * @ingroup api_base_utils
*/
static inline bool
findZero(int width, uint64_t dest)
