commit 7b5409d1e8ed49214356f075e71b54383672038a
author Hoa Nguyen <hoanguyen@ucdavis.edu> Thu Aug 20 16:57:46 2020 -0700
committer Hoa Nguyen <hoanguyen@ucdavis.edu> Tue Sep 08 16:24:06 2020 +0000
tree 427219c6a02ac8a01a8157941abb313937bba0b6
parent 51992fa80af477097ece177610ec9e05aef03df4

base: Tag API methods and variables in random.hh

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

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__