Document show_program.h

No functional change.

Author: romainbrenguier

src/goto-symex/show_program.h

@@ -15,6 +15,14 @@ Author: Daniel Kroening, [email protected]
 class namespacet;
 class symex_target_equationt;
 
+/// Print the steps of \p equation on the standard output.
+///
+/// For each step, prints the location, then if the step is an assignment,
+/// assertion, assume, constraint, shared read or shared write:
+/// prints an instruction counter, followed by the instruction type, and the
+/// current guard if it is not equal to true.
+/// \param ns: namespace
+/// \param equation: SSA form of the program
 void show_program(const namespacet &ns, const symex_target_equationt &equation);
 
 #endif // CPROVER_GOTO_SYMEX_SHOW_PROGRAM_H