Skip to content

Commit f985d81

Browse files
MatWisetautschnig
authored andcommitted
Fix Doxygen formatting
1 parent 8cf378e commit f985d81

File tree

5 files changed

+15
-15
lines changed

5 files changed

+15
-15
lines changed

src/statement-list/converters/expr2statement_list.cpp

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Author: Matthias Weiss, [email protected]
5959
/// such. This can reduce complexity in some cases.
6060
/// \param lhs: Left side of the binary expression.
6161
/// \param rhs: Right side of the binary expression.
62-
/// \return: List of instrumented operands.
62+
/// \return List of instrumented operands.
6363
static std::vector<exprt>
6464
instrument_equal_operands(const exprt &lhs, const exprt &rhs)
6565
{
@@ -93,7 +93,7 @@ instrument_equal_operands(const exprt &lhs, const exprt &rhs)
9393

9494
/// Checks if the expression or one of its parameters is not of type bool.
9595
/// \param expr: Expression to verify.
96-
/// \return: True if the expression and its operands are not or only partially
96+
/// \return True if the expression and its operands are not or only partially
9797
/// of type bool, false otherwise.
9898
static bool is_not_bool(const exprt &expr)
9999
{

src/statement-list/converters/expr2statement_list.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ class expr2stlt
6262
/// recursively in the process.
6363
/// \param expr: Expression to convert. Operands of this expression will be
6464
/// converted as well via recursion.
65-
/// \return: String containing human-readable STL code for the expression.
65+
/// \return String containing human-readable STL code for the expression.
6666
std::string convert(const exprt &expr);
6767

6868
private:
@@ -147,7 +147,7 @@ class expr2stlt
147147
/// Returns the given identifier in a form that is compatible with STL by
148148
/// looking up the symbol or cutting the scope when needed.
149149
/// \param identifier: Identifier that should be converted.
150-
/// \return: Converted identifier.
150+
/// \return Converted identifier.
151151
irep_idt id_shorthand(const irep_idt &identifier);
152152
};
153153

src/statement-list/statement_list_language.h

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ class statement_list_languaget : public languaget
3232
/// instance's parse tree.
3333
/// \param instream: Input to parse.
3434
/// \param path: Path of the input.
35-
/// \return: False if successful.
35+
/// \return False if successful.
3636
bool parse(std::istream &instream, const std::string &path) override;
3737

3838
/// Currently unused.
@@ -45,7 +45,7 @@ class statement_list_languaget : public languaget
4545
/// \param module: Name of the file that has been parsed.
4646
/// \param keep_file_local: Set to true if local variables of this module
4747
/// should be included in the table.
48-
/// \return: False if no errors occurred, true otherwise.
48+
/// \return False if no errors occurred, true otherwise.
4949
bool typecheck(
5050
symbol_tablet &symbol_table,
5151
const std::string &module,

src/statement-list/statement_list_parser.h

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ class statement_list_parsert : public parsert
3636
public:
3737
/// Starts the parsing process and saves the result inside of this instance's
3838
/// parse tree.
39-
/// \return: False if successful.
39+
/// \return False if successful.
4040
bool parse() override;
4141

4242
/// Adds a function block to the parse tree by converting the \p block

src/statement-list/statement_list_typecheck.h

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class symbolt;
2828
/// \param module: Name of the file that has been parsed.
2929
/// \param message_handler: Used to provide debug information and error
3030
/// messages.
31-
/// \return: False if no errors occurred, true otherwise.
31+
/// \return False if no errors occurred, true otherwise.
3232
bool statement_list_typecheck(
3333
const statement_list_parse_treet &parse_tree,
3434
symbol_tablet &symbol_table,
@@ -198,7 +198,7 @@ class statement_list_typecheckt : public typecheckt
198198
/// Creates a data block type for the given function block.
199199
/// \param function_block: Function block with an interface that should be
200200
/// converted to a data block.
201-
/// \return: A type representation of an instance data block for the
201+
/// \return A type representation of an instance data block for the
202202
/// function block.
203203
struct_typet create_instance_data_block_type(
204204
const statement_list_parse_treet::function_blockt &function_block);
@@ -627,7 +627,7 @@ class statement_list_typecheckt : public typecheckt
627627
/// Performs a typecheck on a STL instruction with an additional operand that
628628
/// should be no constant.
629629
/// \param op_code: OP code of the instruction.
630-
/// \return: Reference to the operand.
630+
/// \return Reference to the operand.
631631
const symbol_exprt &
632632
typecheck_instruction_with_non_const_operand(const codet &op_code);
633633

@@ -655,7 +655,7 @@ class statement_list_typecheckt : public typecheckt
655655
/// \param tia_element: Symbol representation of the TIA element.
656656
/// \param negate: Whether the operand should be negated (e.g. for the
657657
/// `AND NOT` expression).
658-
/// \return: Typechecked operand.
658+
/// \return Typechecked operand.
659659
exprt typecheck_simple_boolean_instruction_operand(
660660
const codet &op_code,
661661
const symbolt &tia_element,
@@ -677,7 +677,7 @@ class statement_list_typecheckt : public typecheckt
677677
/// Performs a typecheck on the given identifier and returns its symbol.
678678
/// \param identifier: Identifier that should be checked.
679679
/// \param tia_element: Symbol representation of the current TIA module.
680-
/// \return: Expression including the symbol's name and type.
680+
/// \return Expression including the symbol's name and type.
681681
exprt
682682
typecheck_identifier(const symbolt &tia_element, const irep_idt &identifier);
683683

@@ -717,7 +717,7 @@ class statement_list_typecheckt : public typecheckt
717717
/// \param assignments: Assignment list of the function call.
718718
/// \param param: Parameter that should be checked.
719719
/// \param tia_element: Symbol representation of the TIA element.
720-
/// \return: Expression including the assigned symbol's name and type.
720+
/// \return Expression including the assigned symbol's name and type.
721721
exprt typecheck_function_call_arguments(
722722
const std::vector<equal_exprt> &assignments,
723723
const code_typet::parametert &param,
@@ -727,7 +727,7 @@ class statement_list_typecheckt : public typecheckt
727727
/// returns the typechecked version.
728728
/// \param tia_element: Symbol representation of the TIA element.
729729
/// \param rhs: Expression that the function parameter got assigned to.
730-
/// \return: Expression of either a symbol or a constant.
730+
/// \return Expression of either a symbol or a constant.
731731
exprt typecheck_function_call_argument_rhs(
732732
const symbolt &tia_element,
733733
const exprt &rhs);
@@ -738,7 +738,7 @@ class statement_list_typecheckt : public typecheckt
738738
/// \param assignments: Assignment list of the function call.
739739
/// \param return_type: Type of the return value.
740740
/// \param tia_element: Symbol representation of the TIA element.
741-
/// \return: Expression including the assigned symbol's name and type.
741+
/// \return Expression including the assigned symbol's name and type.
742742
exprt typecheck_return_value_assignment(
743743
const std::vector<equal_exprt> &assignments,
744744
const typet &return_type,

0 commit comments

Comments
 (0)