Skip to content

Commit 92a52a5

Browse files
author
thk123
committed
Corrected doxygen errors
1 parent c6f1430 commit 92a52a5

File tree

6 files changed

+19
-11
lines changed

6 files changed

+19
-11
lines changed

src/ansi-c/ansi_c_entry_point.cpp

+2-1
Original file line numberDiff line numberDiff line change
@@ -195,10 +195,11 @@ bool ansi_c_entry_point(
195195

196196

197197
/// Generate a _start function for a specific function
198-
/// \param entry_function_symbol: The symbol for the function that should be
198+
/// \param symbol: The symbol for the function that should be
199199
/// used as the entry point
200200
/// \param symbol_table: The symbol table for the program. The new _start
201201
/// function symbol will be added to this table
202+
/// \param message_handler: The message handler
202203
/// \return Returns false if the _start method was generated correctly
203204
bool generate_ansi_c_start_function(
204205
const symbolt &symbol,

src/ansi-c/ansi_c_language.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ void ansi_c_languaget::modules_provided(std::set<std::string> &modules)
3737
}
3838

3939
/// Generate a _start function for a specific function
40-
/// \param entry_function_symbol: The symbol for the function that should be
40+
/// \param entry_function_symbol_id: The symbol for the function that should be
4141
/// used as the entry point
4242
/// \param symbol_table: The symbol table for the program. The new _start
4343
/// function symbol will be added to this table

src/cpp/cpp_language.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ void cpp_languaget::modules_provided(std::set<std::string> &modules)
5454
}
5555

5656
/// Generate a _start function for a specific function
57-
/// \param entry_function_symbol: The symbol for the function that should be
57+
/// \param entry_function_symbol_id: The symbol for the function that should be
5858
/// used as the entry point
5959
/// \param symbol_table: The symbol table for the program. The new _start
6060
/// function symbol will be added to this table

src/java_bytecode/java_bytecode_language.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ void java_bytecode_languaget::modules_provided(std::set<std::string> &modules)
107107
}
108108

109109
/// Generate a _start function for a specific function.
110-
/// \param entry_function_symbol: The symbol for the function that should be
110+
/// \param entry_function_symbol_id: The symbol for the function that should be
111111
/// used as the entry point
112112
/// \param symbol_table: The symbol table for the program. The new _start
113113
/// function symbol will be added to this table

src/java_bytecode/java_entry_point.cpp

+13-6
Original file line numberDiff line numberDiff line change
@@ -520,12 +520,19 @@ bool java_entry_point(
520520
pointer_type_selector);
521521
}
522522

523-
/// Generate a _start function for a specific function
524-
/// \param entry_function_symbol: The symbol for the function that should be
525-
/// used as the entry point
526-
/// \param symbol_table: The symbol table for the program. The new _start
527-
/// function symbol will be added to this table
528-
/// \return Returns false if the _start method was generated correctly
523+
/// Generate a _start function for a specific function. See
524+
/// java_entry_point for more details.
525+
/// \param symbol: The symbol representing the function to call
526+
/// \param symbol_table: Global symbol table
527+
/// \param message_handler: Where to write output to
528+
/// \param assume_init_pointers_not_null: When creating pointers, assume they
529+
/// always take a non-null value.
530+
/// \param max_nondet_array_length: The length of the arrays to create when
531+
/// filling them
532+
/// \param max_nondet_tree_depth: defines the maximum depth of the object tree
533+
/// (see java_entry_points documentation for details)
534+
/// \param pointer_type_selector: Logic for substituting types of pointers
535+
/// \returns true if error occurred on entry point search, false otherwise
529536
bool generate_java_start_function(
530537
const symbolt &symbol,
531538
symbol_tablet &symbol_table,

src/jsil/jsil_language.cpp

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ bool jsil_languaget::interfaces(symbol_tablet &symbol_table)
4242
}
4343

4444
/// Generate a _start function for a specific function
45-
/// \param entry_function_symbol: The symbol for the function that should be
45+
/// \param entry_function_symbol_id: The symbol for the function that should be
4646
/// used as the entry point
4747
/// \param symbol_table: The symbol table for the program. The new _start
4848
/// function symbol will be added to this table

0 commit comments

Comments
 (0)