Gabe Black has uploaded this change for review. (
https://gem5-review.googlesource.com/c/public/gem5/+/36278 )
Change subject: sim: Fix API comments for optParamIn.
......................................................................
sim: Fix API comments for optParamIn.
The top level comment was correct, but the parameter comments talked
about writing parameters instead of reading them. Also simplified the
wording of the return value comment.
Change-Id: I156aba5b69c281ee2f34297bf3f75fd0acfb2b6e
---
M src/sim/serialize.hh
1 file changed, 4 insertions(+), 5 deletions(-)
diff --git a/src/sim/serialize.hh b/src/sim/serialize.hh
index 2ca2b91..1a1193b 100644
--- a/src/sim/serialize.hh
+++ b/src/sim/serialize.hh
@@ -473,13 +473,12 @@
/**
* This function is used for restoring optional parameters from the
* checkpoint.
- * @param cp The checkpoint to be written to.
- * @param name Name of the parameter to be written.
- * @param param Value of the parameter to be written.
+ * @param cp The checkpoint to be read from.
+ * @param name Name of the parameter to be read.
+ * @param param Value of the parameter to be read.
* @param warn If the warn is set to true then the function prints the
warning
* message.
- * @return If the parameter we are searching for does not exist
- * the function returns false else it returns true.
+ * @return Returns if the parameter existed in the checkpoint.
*
* @ingroup api_serialize
*/
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/36278
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: I156aba5b69c281ee2f34297bf3f75fd0acfb2b6e
Gerrit-Change-Number: 36278
Gerrit-PatchSet: 1
Gerrit-Owner: Gabe Black <[email protected]>
Gerrit-MessageType: newchange
_______________________________________________
gem5-dev mailing list -- [email protected]
To unsubscribe send an email to [email protected]
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
