Skip to content

Commit 71340ee

Browse files
author
Matthias Güdemann
committed
Clarify documentation
1 parent 30b44f6 commit 71340ee

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/util/nondet.cpp

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ Module: Non-deterministic object init and choice for CBMC
2222
/// ```
2323
/// \param min_value: Minimum value (inclusive) of returned int.
2424
/// \param max_value: Maximum value (inclusive) of returned int.
25-
/// \param name_prefix: Prefix for the fresh symbol name generated.
25+
/// \param name_prefix: Prefix for the fresh symbol name generated (should be
26+
/// function id)
2627
/// \param int_type: The type of the int used to non-deterministically choose
2728
/// one of the switch cases.
2829
/// \param source_location: The location to mark the generated int with.
@@ -73,7 +74,7 @@ symbol_exprt generate_nondet_int(
7374
}
7475

7576
/// Pick nondeterministically between imperative actions 'switch_cases'.
76-
/// \param name_prefix: Name prefix for fresh symbols
77+
/// \param name_prefix: Name prefix for fresh symbols (should be function id)
7778
/// \param switch_cases: List of codet objects to execute in each switch case.
7879
/// \param int_type: The type of the int used to non-deterministically choose
7980
/// one of the switch cases.

0 commit comments

Comments
 (0)