From: Hoa Nguyen <hoanguyen@ucdavis.edu>
Date: Mon, 24 Aug 2020 04:56:06 +0000 (-0700)
Subject: base: Tag API methods to trace.hh
X-Git-Tag: v20.1.0.0~85
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=c314c1fa9eac8452c296f9096aa3e54d315fdf1b;p=gem5.git

base: Tag API methods to trace.hh

Change-Id: Ia2ad759b9bee4fd3413abd62cfa6b120616a14f9
Signed-off-by: Hoa Nguyen <hoanguyen@ucdavis.edu>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/33255
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/trace.hh b/src/base/trace.hh
index c3a499b9d..3d8752cfc 100644
--- a/src/base/trace.hh
+++ b/src/base/trace.hh
@@ -156,15 +156,27 @@ class Named
     const std::string &name() const { return _name; }
 };
 
-//
-// DPRINTF is a debugging trace facility that allows one to
-// selectively enable tracing statements.  To use DPRINTF, there must
-// be a function or functor called name() that returns a const
-// std::string & in the current scope.
-//
-// If you desire that the automatic printing not occur, use DPRINTFR
-// (R for raw)
-//
+/**
+ * DPRINTF is a debugging trace facility that allows one to
+ * selectively enable tracing statements.  To use DPRINTF, there must
+ * be a function or functor called name() that returns a const
+ * std::string & in the current scope.
+ *
+ * If you desire that the automatic printing not occur, use DPRINTFR
+ * (R for raw)
+ *
+ * \def DDUMP(x, data, count)
+ * \def DPRINTF(x, ...)
+ * \def DPRINTFS(x, s, ...)
+ * \def DPRINTFR(x, ...)
+ * \def DDUMPN(data, count)
+ * \def DPRINTFN(...)
+ * \def DPRINTFNR(...)
+ * \def DPRINTF_UNCONDITIONAL(x, ...)
+ *
+ * @ingroup api_trace
+ * @{
+ */
 
 #if TRACING_ON
 
@@ -229,4 +241,6 @@ class Named
 
 #endif  // TRACING_ON
 
+/** @} */ // end of api_trace
+
 #endif // __BASE_TRACE_HH__