remove_function_pointers: more documentation

Author: Daniel Kroening

src/goto-programs/remove_function_pointers.cpp

@@ -47,9 +47,12 @@ class remove_function_pointerst:public messaget
   // a set of function symbols
   using functionst = remove_const_function_pointerst::functionst;
 
-  // replace a call to a dynamic function at location
-  // target in the given goto-program by a case-split
-  //  over a given set of functions
+  /// Replace a call to a dynamic function at location
+  /// target in the given goto-program by a case-split
+  /// over a given set of functions
+  /// \param goto_program The goto program that contains target
+  /// \param target location with function call with function pointer
+  /// \param functions The set of functions to consider
   void remove_function_pointer(
     goto_programt &goto_program,
     goto_programt::targett target,
@@ -68,6 +71,11 @@ class remove_function_pointerst:public messaget
   // --remove-const-function-pointers instead of --remove-function-pointers
   bool only_resolve_const_fps;
 
+  /// Replace a call to a dynamic function at location
+  /// target in the given goto-program by determining
+  /// functions that have a compatible signature
+  /// \param goto_program The goto program that contains target
+  /// \param target location with function call with function pointer
   void remove_function_pointer(
     goto_programt &goto_program,
     goto_programt::targett target);