Skip to content

Commit 5fbb205

Browse files
author
svorenova
committed
Add documentation to std_types
1 parent 59267da commit 5fbb205

File tree

2 files changed

+309
-479
lines changed

2 files changed

+309
-479
lines changed

src/util/std_types.cpp

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
/*******************************************************************\
22
3-
Module:
3+
Module: Pre-defined types
44
55
Author: Daniel Kroening, [email protected]
6+
Maria Svorenova, [email protected]
67
78
\*******************************************************************/
89

10+
/// \file
11+
/// Pre-defined types
12+
913
#include "std_types.h"
1014

1115
#include "string2int.h"
@@ -26,6 +30,7 @@ std::size_t floatbv_typet::get_f() const
2630
return unsafe_string2unsigned(id2string(f));
2731
}
2832

33+
/// Return the sequence number of the component with given name.
2934
std::size_t struct_union_typet::component_number(
3035
const irep_idt &component_name) const
3136
{
@@ -48,6 +53,7 @@ std::size_t struct_union_typet::component_number(
4853
return 0;
4954
}
5055

56+
/// Get the component with given name.
5157
const struct_union_typet::componentt &struct_union_typet::get_component(
5258
const irep_idt &component_name) const
5359
{
@@ -73,6 +79,7 @@ typet struct_union_typet::component_type(
7379
return c.type();
7480
}
7581

82+
/// Returns true if the object is a prefix of \param other.
7683
bool struct_typet::is_prefix_of(const struct_typet &other) const
7784
{
7885
const componentst &ot_components=other.components();

0 commit comments

Comments
 (0)