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
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/36278
Maintainer: Gabe Black <gabe.black@gmail.com>
Maintainer: Andreas Sandberg <andreas.sandberg@arm.com>
Reviewed-by: Andreas Sandberg <andreas.sandberg@arm.com>
Reviewed-by: Jason Lowe-Power <power.jg@gmail.com>
Tested-by: kokoro <noreply+kokoro@google.com>

diff --git a/src/sim/serialize.hh b/src/sim/serialize.hh
index 22c40aac0331d2349ba83d8b3b09c105ea03e499..b5fb47ca9cab4d9cc8eb902dd0cf36145aebb510 100644 (file)
--- a/src/sim/serialize.hh
+++ b/src/sim/serialize.hh
@@ -482,13 +482,12 @@ paramInImpl(CheckpointIn &cp, const std::string &name, T &param)
 /**
  * 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 do_warn If the do_warn is set to true then the function prints the
+ * @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 do_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
  */