Merge pull request #2771 from svorenova/doc_typet

Complete typet documentation [DOC-12]

Author: svorenova

src/util/base_type.cpp

@@ -320,6 +320,15 @@ bool base_type_eqt::base_type_eq_rec(
   return true;
 }
 
+/// Check types for equality across all levels of hierarchy. For equality
+/// in the top level of the hierarchy only use \ref type_eq.
+/// Example:
+/// - `symbol_typet("a")` and `ns.lookup("a").type` will compare equal,
+/// - `struct_typet {symbol_typet("a")}` and `struct_typet {ns.lookup("a")
+///   .type}` will also compare equal.
+/// \param type1 The first type to compare.
+/// \param type2 The second type to compare.
+/// \param ns The namespace, needed for resolution of symbols.
 bool base_type_eq(
   const typet &type1,
   const typet &type2,
@@ -329,6 +338,10 @@ bool base_type_eq(
   return base_type_eq.base_type_eq(type1, type2);
 }
 
+/// Check expressions for equality across all levels of hierarchy.
+/// \param expr1 The first expression to compare.
+/// \param expr2 The second expression to compare.
+/// \param ns The namespace, needed for resolution of symbols.
 bool base_type_eq(
   const exprt &expr1,
   const exprt &expr2,

src/util/std_types.cpp

@@ -1,11 +1,15 @@
 /*******************************************************************\
 
-Module:
+Module: Pre-defined types
 
 Author: Daniel Kroening, [email protected]
+        Maria Svorenova, [email protected]
 
 \*******************************************************************/
 
+/// \file
+/// Pre-defined types
+
 #include "std_types.h"
 
 #include "string2int.h"
@@ -26,6 +30,7 @@ std::size_t floatbv_typet::get_f() const
   return unsafe_string2unsigned(id2string(f));
 }
 
+/// Return the sequence number of the component with given name.
 std::size_t struct_union_typet::component_number(
   const irep_idt &component_name) const
 {
@@ -48,6 +53,7 @@ std::size_t struct_union_typet::component_number(
   return 0;
 }
 
+/// Get the reference to a component with given name.
 const struct_union_typet::componentt &struct_union_typet::get_component(
   const irep_idt &component_name) const
 {
@@ -73,6 +79,10 @@ typet struct_union_typet::component_type(
   return c.type();
 }
 
+/// Returns true if the struct is a prefix of \a other, i.e., if this struct
+/// has n components then the component types and names of this struct must
+/// match the first n components of \a other struct.
+/// \param other Struct type to compare with.
 bool struct_typet::is_prefix_of(const struct_typet &other) const
 {
   const componentst &ot_components=other.components();
@@ -102,12 +112,14 @@ bool struct_typet::is_prefix_of(const struct_typet &other) const
   return true; // ok, *this is a prefix of ot
 }
 
+/// Returns true if the type is a reference.
 bool is_reference(const typet &type)
 {
   return type.id()==ID_pointer &&
          type.get_bool(ID_C_reference);
 }
 
+/// Returns if the type is an R value reference.
 bool is_rvalue_reference(const typet &type)
 {
   return type.id()==ID_pointer &&