Skip to content

Commit 5a3e001

Browse files
committed
Document type2identifier function
In order to specify the properties which are expected to hold for this function.
1 parent 0c08382 commit 5a3e001

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/ansi-c/type2name.h

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,15 @@ class namespacet;
2020

2121
std::string type2name(const typet &type, const namespacet &ns);
2222

23+
/**
24+
* Constructs a string describing the given type, which can be used as part of
25+
* a `C` identifier. The resulting identifier is not guaranteed to uniquely
26+
* identify the type in all cases.
27+
* @param type Internal representation of the type to describe.
28+
* @param ns Namespace for looking up any types on which the `type` parameter
29+
* depends.
30+
* @return An identifying string which can be used as part of a `C` identifier.
31+
*/
2332
std::string type2identifier(const typet &type, const namespacet &ns);
2433

2534
#endif // CPROVER_ANSI_C_TYPE2NAME_H

0 commit comments

Comments
 (0)