Hoa Nguyen has submitted this change. ( https://gem5-review.googlesource.com/c/public/gem5/+/32960 )

Change subject: base: Tag API methods and variables in channel_addr.hh
......................................................................

base: Tag API methods and variables in channel_addr.hh

Change-Id: I91c806e88f035457f93dcfcee1833d6955a07807
Signed-off-by: Hoa Nguyen <hoangu...@ucdavis.edu>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/32960
Reviewed-by: Bobby R. Bruce <bbr...@ucdavis.edu>
Reviewed-by: Jason Lowe-Power <power...@gmail.com>
Maintainer: Bobby R. Bruce <bbr...@ucdavis.edu>
Tested-by: kokoro <noreply+kok...@google.com>
---
M src/base/channel_addr.hh
1 file changed, 17 insertions(+), 1 deletion(-)

Approvals:
  Jason Lowe-Power: Looks good to me, approved
  Bobby R. Bruce: Looks good to me, approved; Looks good to me, approved
  kokoro: Regressions pass



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__

--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/32960
To unsubscribe, or for help writing mail filters, visit https://gem5-review.googlesource.com/settings

Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: I91c806e88f035457f93dcfcee1833d6955a07807
Gerrit-Change-Number: 32960
Gerrit-PatchSet: 5
Gerrit-Owner: Hoa Nguyen <hoangu...@ucdavis.edu>
Gerrit-Reviewer: Bobby R. Bruce <bbr...@ucdavis.edu>
Gerrit-Reviewer: Hoa Nguyen <hoangu...@ucdavis.edu>
Gerrit-Reviewer: Jason Lowe-Power <power...@gmail.com>
Gerrit-Reviewer: kokoro <noreply+kok...@google.com>
Gerrit-MessageType: merged
_______________________________________________
gem5-dev mailing list -- gem5-dev@gem5.org
To unsubscribe send an email to gem5-dev-le...@gem5.org
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s

Reply via email to