commit b1a2f9393dca1ff8da73f97b8b0989e4287acbed
author Hoa Nguyen <hoanguyen@ucdavis.edu> Wed Aug 19 23:39:36 2020 -0700
committer Hoa Nguyen <hoanguyen@ucdavis.edu> Tue Sep 08 16:24:48 2020 +0000
tree 9b1a04aa3ab8ed958c9a7805a9d0e39d50ccdf52
parent b695e09d0720c1c11282c0ab21d792a874daff23

base: Tag API methods and variables in channel_addr.hh

Change-Id: I91c806e88f035457f93dcfcee1833d6955a07807
Signed-off-by: Hoa Nguyen <hoanguyen@ucdavis.edu>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/32960
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>

src/base/channel_addr.hh

diff --git a/src/base/channel_addr.hh b/src/base/channel_addr.hh
index 06fae72..2cfe380 100644
--- a/src/base/channel_addr.hh
+++ b/src/base/channel_addr.hh
@@ -51,7 +51,12 @@
   public:
     using Type = Addr;
 
-    /** Explicit constructor assigning a value. */
+    /**
+     * Explicit constructor assigning a value.
+     *
+     * @ingroup api_channel_addr
+     * @{
+     */
     explicit constexpr ChannelAddr(Type _a) : a(_a) { }
 
     /** Converting back to the value type. */
@@ -131,6 +136,8 @@
     constexpr bool operator==(const ChannelAddr &b) const { return a == b.a; }
     constexpr bool operator!=(const ChannelAddr &b) const { return a != b.a; }
 
+    /** @} */ // end of api_channel_addr
+
   private:
     /** Member holding the actual value. */
     Type a;
@@ -143,6 +150,10 @@
 class ChannelAddrRange
 {
   public:
+    /**
+     * @ingroup api_channel_addr
+     * @{
+     */
     constexpr ChannelAddrRange()
         : ChannelAddrRange(ChannelAddr(1), ChannelAddr(0)) {}
 
@@ -165,6 +176,8 @@
         return a >= _start && a <= _end;
     }
 
+    /** @} */ // end of api_channel_addr
+
   protected:
     ChannelAddr _start;
     ChannelAddr _end;
@@ -186,6 +199,9 @@
     };
 }
 
+/**
+ * @ingroup api_channel_addr
+ */
 std::ostream &operator<<(std::ostream &out, const ChannelAddr &addr);
 
 #endif // __BASE_CHANNEL_ADDR_HH__