Bobby R. Bruce has submitted this change. (
https://gem5-review.googlesource.com/c/public/gem5/+/28390 )
Change subject: misc,base,stats: Tagged API methods in base/stats/group.hh
......................................................................
misc,base,stats: Tagged API methods in base/stats/group.hh
Change-Id: I61693884d719025f3b1f385793c7a71de0937e79
Issue-on: https://gem5.atlassian.net/browse/GEM5-172
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/28390
Tested-by: kokoro <noreply+kok...@google.com>
Reviewed-by: Bobby R. Bruce <bbr...@ucdavis.edu>
Maintainer: Bobby R. Bruce <bbr...@ucdavis.edu>
---
M src/base/stats/group.hh
M src/doxygen/group_definitions.hh
2 files changed, 27 insertions(+), 0 deletions(-)
Approvals:
Bobby R. Bruce: Looks good to me, approved; Looks good to me, approved
kokoro: Regressions pass
diff --git a/src/base/stats/group.hh b/src/base/stats/group.hh
index 4fd9e79..985bf61 100644
--- a/src/base/stats/group.hh
+++ b/src/base/stats/group.hh
@@ -83,9 +83,14 @@
class Group
{
public:
+ /**
+ * @ingroup api_stats
+ * @{
+ */
Group() = delete;
Group(const Group &) = delete;
Group &operator=(const Group &) = delete;
+ /** @}*/ //end of api_stats
/**
* Construct a new statistics group.
@@ -104,6 +109,8 @@
* @param parent Parent group to associate this object to.
* @param name Name of this group, can be NULL to merge this group
* with the parent group.
+ *
+ * @ingroup api_stats
*/
Group(Group *parent, const char *name = nullptr);
@@ -117,11 +124,15 @@
* description. Stat names and descriptions should typically be
* set from the constructor usingo from the constructor using the
* ADD_STAT macro.
+ *
+ * @ingroup api_stats
*/
virtual void regStats();
/**
* Callback to reset stats.
+ *
+ * @ingroup api_stats
*/
virtual void resetStats();
@@ -129,22 +140,30 @@
* Callback before stats are dumped. This can be overridden by
* objects that need to perform calculations in addition to the
* capabiltiies implemented in the stat framework.
+ *
+ * @ingroup api_stats
*/
virtual void preDumpStats();
/**
* Register a stat with this group. This method is normally called
* automatically when a stat is instantiated.
+ *
+ * @ingroup api_stats
*/
void addStat(Stats::Info *info);
/**
* Get all child groups associated with this object.
+ *
+ * @ingroup api_stats
*/
const std::map<std::string, Group *> &getStatGroups() const;
/**
* Get all stats associated with this object.
+ *
+ * @ingroup api_stats
*/
const std::vector<Info *> &getStats() const;
@@ -154,6 +173,8 @@
* This method may only be called from a Group constructor or from
* regStats. It's typically only called explicitly from Python
* when setting up the SimObject hierarchy.
+ *
+ * @ingroup api_stats
*/
void addStatGroup(const char *name, Group *block);
diff --git a/src/doxygen/group_definitions.hh
b/src/doxygen/group_definitions.hh
index c0599bb..e6e39b7 100644
--- a/src/doxygen/group_definitions.hh
+++ b/src/doxygen/group_definitions.hh
@@ -15,3 +15,9 @@
*
* These methods relate to the event queue interface.
*/
+
+/**
+ * @defgroup api_stats The Stats API.
+ *
+ * These methods relate to the statistics I/O interface.
+ */
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/28390
To unsubscribe, or for help writing mail filters, visit
https://gem5-review.googlesource.com/settings
Gerrit-Project: public/gem5
Gerrit-Branch: release-staging-v20.0.0.0
Gerrit-Change-Id: I61693884d719025f3b1f385793c7a71de0937e79
Gerrit-Change-Number: 28390
Gerrit-PatchSet: 6
Gerrit-Owner: Bobby R. Bruce <bbr...@ucdavis.edu>
Gerrit-Reviewer: Alec Roelke <alec.roe...@gmail.com>
Gerrit-Reviewer: Ali Saidi <asa...@gmail.com>
Gerrit-Reviewer: Andreas Sandberg <andreas.sandb...@arm.com>
Gerrit-Reviewer: Anthony Gutierrez <anthony.gutier...@amd.com>
Gerrit-Reviewer: Bobby R. Bruce <bbr...@ucdavis.edu>
Gerrit-Reviewer: Bradford Beckmann <brad.beckm...@amd.com>
Gerrit-Reviewer: Daniel Carvalho <oda...@yahoo.com.br>
Gerrit-Reviewer: Gabe Black <gabebl...@google.com>
Gerrit-Reviewer: Giacomo Travaglini <giacomo.travagl...@arm.com>
Gerrit-Reviewer: Jason Lowe-Power <power...@gmail.com>
Gerrit-Reviewer: Matt Sinclair <mattdsincl...@gmail.com>
Gerrit-Reviewer: kokoro <noreply+kok...@google.com>
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
