From: Hoa Nguyen <hoanguyen@ucdavis.edu>
Date: Mon, 24 Aug 2020 05:06:50 +0000 (-0700)
Subject: base: Tag API methods in amo.hh
X-Git-Tag: v20.1.0.0~96
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=7d056a5dce5f003a6a7857aef9d80aa55f4d6304;p=gem5.git

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 44dec8b6a..23be57d71 100644
--- 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__