Skip to content

Commit ca1b03c

Browse files
Polgreenpolgreen
Polgreen
authored andcommitted
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.
1 parent c4aadab commit ca1b03c

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

src/goto-programs/generate_function_bodies.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ class generate_function_bodiest
3737
public:
3838
virtual ~generate_function_bodiest() = default;
3939

40-
/// Replace the function body with one based on the implementation
41-
/// This will work the same whether or not the function already has a body
40+
/// Replace the function body with one based on the replace_function_body
41+
/// class being used.
4242
/// \param function whose body to replace
4343
/// \param symbol_table of the current goto program
4444
/// \param function_name Identifier of function

0 commit comments

Comments
 (0)