base: Tag API methods in amo.hh

Change-Id: I8014d729611721dd15ee27a974acbab2744c5e82
Signed-off-by: Hoa Nguyen <hoanguyen@ucdavis.edu>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/33274
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/amo.hh b/src/base/amo.hh
index 44dec8b6a32d3926e22ceb16a44710480eefd863..23be57d7181183bf66d7d9190d8cce291e47b5a9 100644 (file)
--- a/src/base/amo.hh
+++ b/src/base/amo.hh
@@ -39,8 +39,13 @@
 
 struct AtomicOpFunctor
 {
+    /**
+     * @ingroup api_atomic_op
+     * @{
+     */
     virtual void operator()(uint8_t *p) = 0;
     virtual AtomicOpFunctor* clone() = 0;
+    /** @} */ // end of api_atomic_op
     virtual ~AtomicOpFunctor() {}
 };
 
@@ -49,6 +54,9 @@ struct TypedAtomicOpFunctor : public AtomicOpFunctor
 {
     void operator()(uint8_t *p) { execute((T *)p); }
     virtual AtomicOpFunctor* clone() = 0;
+    /**
+     * @ingroup api_atomic_op
+     */
     virtual void execute(T * p) = 0;
 };
 
@@ -225,6 +233,9 @@ class AtomicOpMin : public TypedAtomicOpFunctor<T>
     AtomicOpFunctor* clone () { return new AtomicOpMin(a); }
 };
 
+/**
+ * @ingroup api_atomic_op
+ */
 typedef std::unique_ptr<AtomicOpFunctor> AtomicOpFunctorPtr;
 
 #endif // __BASE_AMO_HH__