Skip to content

Commit 9cb4569

Browse files
author
thk123
committed
Amend doxygen comments
1 parent 4550676 commit 9cb4569

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

unit/testing-utils/require_goto_statements.cpp

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
#include <util/expr_iterator.h>
1414

1515
/// Expand value of a function to include all child codets
16-
/// \param instructions: The value of the function (e.g. got by looking up
16+
/// \param function_value: The value of the function (e.g. got by looking up
1717
/// the function in the symbol table and getting the value)
1818
/// \return: All ID_code statements in the tree rooted at \p function_value
1919
std::vector<codet>
@@ -69,7 +69,8 @@ require_goto_statements::find_struct_component_assignments(
6969
return component_assignments;
7070
}
7171

72-
/// For a given variable name, gets the assignments to it in the functions
72+
/// For a given variable name, gets the assignments to it in the provided
73+
/// instructions.
7374
/// \param pointer_name: The name of the variable
7475
/// \param instructions: The instructions to look through
7576
/// \return: A structure that contains the null assignment if found, and a
@@ -110,6 +111,8 @@ require_goto_statements::find_pointer_assignments(
110111
/// \param variable_name: The name of the variable.
111112
/// \param entry_point_instructions: The statements to look through
112113
/// \return The declaration statement corresponding to that variable
114+
/// \throws no_decl_found_exceptiont if no declaration of the specific
115+
/// variable is found
113116
const code_declt &require_goto_statements::require_declaration_of_name(
114117
const irep_idt &variable_name,
115118
const std::vector<codet> &entry_point_instructions)

0 commit comments

Comments
 (0)