From ca1b03c1f6c12ccf0c54e083bda2b41763a50eef Mon Sep 17 00:00:00 2001 From: Polgreen Date: Mon, 18 Jun 2018 10:07:13 +0200 Subject: [PATCH] Documentation wording for replace function bodies Previous use of the word "implementation" is misleading, as "implementation" is synonymous with "function body". Here "implementation" is intended to refer to the derived class used. The previous wording could be interpreted as "replace the function body with one based on the function body, i.e., a summary of the function body code. This will work the same regardless of whether or not the function already has a body". Documentation rewording: generate_function_body This function cannot behave the same whether or not the function passed to it has a function body. The implementation of "generate_function_body" contains a PRECONDITION that the function body is not available. --- src/goto-programs/generate_function_bodies.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/goto-programs/generate_function_bodies.h b/src/goto-programs/generate_function_bodies.h index 61e818a1b7a..29c93545ea9 100644 --- a/src/goto-programs/generate_function_bodies.h +++ b/src/goto-programs/generate_function_bodies.h @@ -37,8 +37,8 @@ class generate_function_bodiest public: virtual ~generate_function_bodiest() = default; - /// Replace the function body with one based on the implementation - /// This will work the same whether or not the function already has a body + /// Replace the function body with one based on the replace_function_body + /// class being used. /// \param function whose body to replace /// \param symbol_table of the current goto program /// \param function_name Identifier of function