add documentation to read_goto_binary and read_object_and_link

Author: Daniel Kroening

src/goto-programs/read_goto_binary.cpp

@@ -27,6 +27,8 @@ Module: Read Goto Programs
 #include "elf_reader.h"
 #include "osx_fat_reader.h"
 
+/// Read given goto binary
+/// Does not update config
 bool read_goto_binary(
   const std::string &filename,
   goto_modelt &dest,
@@ -36,6 +38,8 @@ bool read_goto_binary(
     filename, dest.symbol_table, dest.goto_functions, message_handler);
 }
 
+/// Read given goto binary
+/// Does not update config
 optionalt<goto_modelt>
 read_goto_binary(const std::string &filename, message_handlert &message_handler)
 {
@@ -50,6 +54,8 @@ read_goto_binary(const std::string &filename, message_handlert &message_handler)
     return std::move(dest);
 }
 
+/// Read given goto binary
+/// Does not update config
 bool read_goto_binary(
   const std::string &filename,
   symbol_tablet &symbol_table,
@@ -206,7 +212,7 @@ bool is_goto_binary(const std::string &filename)
   return false;
 }
 
-/// reads an object file
+/// reads an object file, and also updates config
 /// \par parameters: a file_name
 /// \return true on error, false otherwise
 bool read_object_and_link(
@@ -241,7 +247,7 @@ bool read_object_and_link(
   return false;
 }
 
-/// reads an object file
+/// reads an object file, and also updates the config
 /// \par parameters: a file_name
 /// \return true on error, false otherwise
 bool read_object_and_link(