Hoa Nguyen has submitted this change. (
https://gem5-review.googlesource.com/c/public/gem5/+/33054 )
Change subject: base: Tag API methods and variables in fiber.hh
..
base: Tag API methods and variables in fiber.hh
Change-Id: I586183426c8c56929a4640b0a985b4ddbf48c21f
Signed-off-by: Hoa Nguyen
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/33054
Reviewed-by: Gabe Black
Maintainer: Bobby R. Bruce
Tested-by: kokoro
---
M src/base/fiber.hh
1 file changed, 49 insertions(+), 17 deletions(-)
Approvals:
Gabe Black: Looks good to me, approved
Bobby R. Bruce: Looks good to me, approved
kokoro: Regressions pass
diff --git a/src/base/fiber.hh b/src/base/fiber.hh
index 513bf0e..dc7ef01 100644
--- a/src/base/fiber.hh
+++ b/src/base/fiber.hh
@@ -62,40 +62,72 @@
class Fiber
{
public:
+/**
+ * @ingroup api_fiber
+ */
const static size_t DefaultStackSize = 0x5;
-/// stack_size is the size of the stack available to this fiber.
-/// link points to another fiber which will start executing when this
-/// fiber's main function returns.
+/**
+ * @param Link points to another fiber which will start executing when
this
+ * fiber's main function returns.
+ * @param stack_size is the size of the stack available to this fiber.
+ *
+ * @ingroup api_fiber
+ * @{
+ */
Fiber(size_t stack_size=DefaultStackSize);
Fiber(Fiber *link, size_t stack_size=DefaultStackSize);
+/** @} */ // end of api_fiber
+/**
+ * @ingroup api_fiber
+ */
virtual ~Fiber();
-/// Start executing the fiber represented by this object. This function
-/// will "return" when the current fiber is switched back to later on.
+/**
+ * Start executing the fiber represented by this object. This function
+ * will "return" when the current fiber is switched back to later on.
+ *
+ * @ingroup api_fiber
+ */
void run();
-/// Returns whether the "main" function of this fiber has finished.
-///
+/**
+ * Returns whether the "main" function of this fiber has finished.
+ *
+ * @ingroup api_fiber
+ */
bool finished() const { return _finished; };
-/// Returns whether the "main" function of this fiber has started.
-///
+/**
+ * Returns whether the "main" function of this fiber has started.
+ *
+ * @ingroup api_fiber
+ */
bool started() const { return _started; };
-/// Get a pointer to the current running Fiber.
-///
+/**
+ * Get a pointer to the current running Fiber.
+ *
+ * @ingroup api_fiber
+ */
static Fiber *currentFiber();
-/// Get a pointer to the primary Fiber.
-/// This Fiber represents the thread of execution started by the OS,
and
-/// which has a Fiber attached to it after the fact.
+
+/**
+ * Get a pointer to the primary Fiber.
+ * This Fiber represents the thread of execution started by the OS, and
+ * which has a Fiber attached to it after the fact.
+ *
+ * @ingroup api_fiber
+ */
static Fiber *primaryFiber();
protected:
-/// This method is called when this fiber is first run. Override it to
-/// give your fiber something to do. When main returns, the fiber will
-/// mark itself as finished and switch to its link fiber.
+/**
+ * This method is called when this fiber is first run. Override it to
+ * give your fiber something to do. When main returns, the fiber will
+ * mark itself as finished and switch to its link fiber.
+ */
virtual void main() = 0;
void setStarted() { _started = true; }
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/33054
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: I586183426c8c56929a4640b0a985b4ddbf48c21f
Gerrit-Change-Number: 33054
Gerrit-PatchSet: 3
Gerrit-Owner: Hoa Nguyen
Gerrit-Reviewer: Bobby R. Bruce
Gerrit-Reviewer: Gabe Black
Gerrit-Reviewer: Giacomo Travaglini
Gerrit-Reviewer: Hoa Nguyen
Gerrit-Reviewer: Jason Lowe-Power
Gerrit-Reviewer: kokoro
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
