Add documentation to type_eq

Author: svorenova

src/util/type_eq.cpp

@@ -1,20 +1,26 @@
 /*******************************************************************\
 
-Module: Type Checking
+Module: Type checking
 
 Author: Daniel Kroening, [email protected]
+        Maria Svorenova, [email protected]
 
 \*******************************************************************/
 
 /// \file
-/// Type Checking
+/// Type checking
 
 #include "type_eq.h"
 
 #include "namespace.h"
 #include "std_types.h"
 #include "symbol.h"
 
+/// Check types for equality. If either of the types is a symbol type, i.e. a
+/// reference into the symbol table, retrieve it from the namespace and compare.
+/// \param type1 The first type to compare.
+/// \param type2 The second type to compare.
+/// \param ns The namespace, needed for resolution of symbols.
 bool type_eq(const typet &type1, const typet &type2, const namespacet &ns)
 {
   if(type1==type2)

src/util/type_eq.h

@@ -1,11 +1,14 @@
 /*******************************************************************\
 
-Module:
+Module: Type checking
 
 Author: Daniel Kroening, [email protected]
+        Maria Svorenova, [email protected]
 
 \*******************************************************************/
 
+/// \file
+/// Type checking
 
 #ifndef CPROVER_UTIL_TYPE_EQ_H
 #define CPROVER_UTIL_TYPE_EQ_H