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

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

base: Tag API methods and variables in random.hh

Change-Id: I75f8843ee696055f156aa0d9e035094d8206f4b9
Signed-off-by: Hoa Nguyen <hoangu...@ucdavis.edu>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/33115
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/random.hh
1 file changed, 16 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/random.hh b/src/base/random.hh
index cc13446..f161d71 100644
--- a/src/base/random.hh
+++ b/src/base/random.hh
@@ -64,8 +64,13 @@

   public:

+    /**
+     * @ingroup api_base_utils
+     * @{
+     */
     Random();
     Random(uint32_t s);
+    /** @} */ // end of api_base_utils
     ~Random();

     void init(uint32_t s);
@@ -73,6 +78,8 @@
     /**
      * Use the SFINAE idiom to choose an implementation based on
      * whether the type is integral or floating point.
+     *
+     * @ingroup api_base_utils
      */
     template <typename T>
     typename std::enable_if<std::is_integral<T>::value, T>::type
@@ -83,6 +90,9 @@
         return dist(gen);
     }

+    /**
+     * @ingroup api_base_utils
+     */
     template <typename T>
     typename std::enable_if<std::is_floating_point<T>::value, T>::type
     random()
@@ -91,7 +101,9 @@
         std::uniform_real_distribution<T> dist;
         return dist(gen);
     }
-
+    /**
+     * @ingroup api_base_utils
+     */
     template <typename T>
     typename std::enable_if<std::is_integral<T>::value, T>::type
     random(T min, T max)
@@ -104,6 +116,9 @@
     void unserialize(CheckpointIn &cp) override;
 };

+/**
+ * @ingroup api_base_utils
+ */
 extern Random random_mt;

 #endif // __BASE_RANDOM_HH__

--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/33115
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: I75f8843ee696055f156aa0d9e035094d8206f4b9
Gerrit-Change-Number: 33115
Gerrit-PatchSet: 3
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