From 37146cb94237829fdce1c43e01d90199f1074086 Mon Sep 17 00:00:00 2001 From: Gabe Black Date: Tue, 20 Oct 2020 19:03:00 -0700 Subject: [PATCH] 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 Maintainer: Andreas Sandberg Reviewed-by: Andreas Sandberg Reviewed-by: Jason Lowe-Power Tested-by: kokoro --- src/sim/serialize.hh | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/src/sim/serialize.hh b/src/sim/serialize.hh index 22c40aac0..b5fb47ca9 100644 --- a/src/sim/serialize.hh +++ b/src/sim/serialize.hh @@ -482,13 +482,12 @@ paramInImpl(CheckpointIn &cp, const std::string &name, T ¶m) /** * 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 */ -- 2.30.2