diff --git a/src/base/remote_gdb.hh b/src/base/remote_gdb.hh index fc259902e2..3ab0feb02d 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.