From: Hoa Nguyen <hoanguyen@ucdavis.edu>
Date: Mon, 24 Aug 2020 05:23:45 +0000 (-0700)
Subject: base: Tag API methods in remote_gdb.hh
X-Git-Tag: v20.1.0.0~86
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=6bccc9e8e422e199793aa1d7e027a671e8c2e77e;p=gem5.git

base: Tag API methods in remote_gdb.hh

Change-Id: I7d4d6ce8a2b18a365561ad88434fea7d6823d310
Signed-off-by: Hoa Nguyen <hoanguyen@ucdavis.edu>
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/33256
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/remote_gdb.hh b/src/base/remote_gdb.hh
index fc259902e..3ab0feb02 100644
--- a/src/base/remote_gdb.hh
+++ b/src/base/remote_gdb.hh
@@ -75,23 +75,31 @@ class BaseGdbRegCache
      * Return the pointer to the raw bytes buffer containing the
      * register values.  Each byte of this buffer is literally
      * encoded as two hex digits in the g or G RSP packet.
+     *
+     * @ingroup api_remote_gdb
      */
     virtual char *data() const = 0;
 
     /**
      * Return the size of the raw buffer, in bytes
      * (i.e., half of the number of digits in the g/G packet).
+     *
+     * @ingroup api_remote_gdb
      */
     virtual size_t size() const = 0;
 
     /**
      * Fill the raw buffer from the registers in the ThreadContext.
+     *
+     * @ingroup api_remote_gdb
      */
     virtual void getRegs(ThreadContext*) = 0;
 
     /**
      * Set the ThreadContext's registers from the values
      * in the raw buffer.
+     *
+     * @ingroup api_remote_gdb
      */
     virtual void setRegs(ThreadContext*) const = 0;
 
@@ -100,9 +108,14 @@ class BaseGdbRegCache
      * Having each concrete superclass redefine this member
      * is useful in situations where the class of the regCache
      * can change on the fly.
+     *
+     * @ingroup api_remote_gdb
      */
     virtual const std::string name() const = 0;
 
+    /**
+     * @ingroup api_remote_gdb
+     */
     BaseGdbRegCache(BaseRemoteGDB *g) : gdb(g)
     {}
     virtual ~BaseGdbRegCache()
@@ -117,7 +130,12 @@ class BaseRemoteGDB
     friend class HardBreakpoint;
   public:
 
-    /*
+    /**
+     * @ingroup api_remote_gdb
+     * @{
+     */
+
+    /**
      * Interface to other parts of the simulator.
      */
     BaseRemoteGDB(System *system, ThreadContext *context, int _port);
@@ -139,6 +157,8 @@ class BaseRemoteGDB
     bool trap(int type);
     bool breakpoint() { return trap(SIGTRAP); }
 
+    /** @} */ // end of api_remote_gdb
+
   private:
     /*
      * Connection to the external GDB.