Documentation wording for replace function bodies

Polgreen · polgreen · commit ca1b03c1f6c1 · 2018-06-20T09:30:25.000+02:00
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.
diff --git 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
