Correct parameter names to stop doxygen warning

Owen Jones · Owen Jones · commit 68ca9a1807e6 · 2018-08-21T17:24:39.000+01:00
diff --git a/jbmc/unit/java-testing-utils/require_type.cpp b/jbmc/unit/java-testing-utils/require_type.cpp
@@ -359,7 +359,7 @@ require_type::require_java_implicitly_generic_class(const typet &class_type)
 /// Verify that a class is a valid java generic class with the
 /// specified list of variables.
 /// \param class_type: the class
-/// \param type_variables: vector of type variables
+/// \param implicit_type_variables: vector of type variables
 /// \return: A reference to the java generic class type.
 java_implicitly_generic_class_typet
 require_type::require_java_implicitly_generic_class(
@@ -403,7 +403,7 @@ require_type::require_complete_java_implicitly_generic_class(
 /// Verify that a class is a complete, valid java generic class with the
 /// specified list of variables.
 /// \param class_type: the class
-/// \param type_variables: vector of type variables
+/// \param implicit_type_variables: vector of type variables
 /// \return: A reference to the java generic class type.
 java_implicitly_generic_class_typet
 require_type::require_complete_java_implicitly_generic_class(
@@ -508,7 +508,7 @@ java_generic_symbol_typet require_type::require_java_generic_symbol_type(
 
 /// Verify that the lambda method handles of a class match the given
 /// expectation.
-/// \param class_struct class type to be verified
+/// \param class_type class type to be verified
 /// \param expected_identifiers expected list of lambda method handle
 ///   references
 /// \return lambda method handles of the class
diff --git a/src/goto-programs/remove_virtual_functions.cpp b/src/goto-programs/remove_virtual_functions.cpp
@@ -301,17 +301,18 @@ goto_programt::targett remove_virtual_functionst::remove_virtual_function(
 
 /// Used by get_functions to track the most-derived parent that provides an
 /// override of a given function.
-/// \param parameters: `this_id`: class name
-/// \param `last_method_defn`: the most-derived parent of `this_id` to define
+/// \param this_id: class name
+/// \param last_method_defn: the most-derived parent of `this_id` to define
 ///   the requested function
-/// \param `component_name`: name of the function searched for
-/// \param `entry_map`: map of class identifiers to dispatch table entries
-/// \param `resolve_function_call`: function to resolve abstract method call
-/// \return `functions` is assigned a list of {class name, function symbol}
-///   pairs indicating that if `this` is of the given class, then the call will
-///   target the given function. Thus if A <: B <: C and A and C provide
-///   overrides of `f` (but B does not), get_child_functions_rec("C", C.f, "f")
+/// \param component_name: name of the function searched for
+/// \param [out] functions: `functions` is assigned a list of
+///   {class name, function symbol} pairs indicating that if `this` is of the
+///   given class, then the call will target the given function. Thus if
+///   A <: B <: C and A and C provide overrides of `f` (but B does not),
+///   get_child_functions_rec("C", C.f, "f")
 ///   -> [{"C", C.f}, {"B", C.f}, {"A", A.f}]
+/// \param entry_map: map of class identifiers to dispatch table entries
+/// \param resolve_function_call`: function to resolve abstract method call
 void remove_virtual_functionst::get_child_functions_rec(
   const irep_idt &this_id,
   const symbol_exprt &last_method_defn,
diff --git a/src/goto-programs/show_goto_functions_json.cpp b/src/goto-programs/show_goto_functions_json.cpp
@@ -25,8 +25,8 @@ Author: Thomas Kiley
 #include "goto_model.h"
 
 /// For outputting the GOTO program in a readable JSON format.
-/// \param ns: the namespace to use to resolve names with
-/// \param list_only: output only list of functions, but not their bodies
+/// \param _ns: the namespace to use to resolve names with
+/// \param _list_only: output only list of functions, but not their bodies
 show_goto_functions_jsont::show_goto_functions_jsont(
   const namespacet &_ns,
   bool _list_only)
diff --git a/src/goto-programs/show_goto_functions_xml.cpp b/src/goto-programs/show_goto_functions_xml.cpp
@@ -24,8 +24,8 @@ Author: Thomas Kiley
 #include "goto_model.h"
 
 /// For outputting the GOTO program in a readable xml format.
-/// \param ns: the namespace to use to resolve names with
-/// \param list_only: output only list of functions, but not their bodies
+/// \param _ns: the namespace to use to resolve names with
+/// \param _list_only: output only list of functions, but not their bodies
 show_goto_functions_xmlt::show_goto_functions_xmlt(
   const namespacet &_ns,
   bool _list_only)
diff --git a/src/goto-programs/system_library_symbols.cpp b/src/goto-programs/system_library_symbols.cpp
@@ -257,8 +257,9 @@ void system_library_symbolst::add_to_system_library(
 /// fake symbol with the given type, to determine whether the type alone
 /// is sufficient to classify a symbol of that type as internal.
 /// \param type: the type to check
-/// \return True if the type is an internal type. If specific system headers
-///   need to be included, the out_system_headers will contain the headers.
+/// \param [out] out_system_headers: specific system headers that need to be
+///   included
+/// \return True if the type is an internal type
 bool system_library_symbolst::is_type_internal(
   const typet &type,
   std::set<std::string> &out_system_headers) const
@@ -270,8 +271,9 @@ bool system_library_symbolst::is_type_internal(
 
 /// To find out if a symbol is an internal symbol.
 /// \param symbol: the symbol to check
-/// \return True if the symbol is an internal symbol. If specific system headers
-///   need to be included, the out_system_headers will contain the headers.
+/// \param [out] out_system_headers: specific system headers that need to be
+///   included
+/// \return True if the symbol is an internal symbol
 bool system_library_symbolst::is_symbol_internal_symbol(
   const symbolt &symbol,
   std::set<std::string> &out_system_headers) const
diff --git a/src/pointer-analysis/value_set.h b/src/pointer-analysis/value_set.h
@@ -213,7 +213,7 @@ class value_sett
   /// \param dest: object map to update
   /// \param n: object number to add; must be mapped to the corresponding
   ///   expression by `object_numbering`.
-  /// \param object: offset into object `n` (may be unknown).
+  /// \param offset: offset into object `n` (may be unknown).
   bool insert(
     object_mapt &dest,
     object_numberingt::number_type n,
@@ -224,7 +224,7 @@ class value_sett
   /// with a differing offset its offset is marked unknown.
   /// \param dest: object map to update
   /// \param expr: expression to add
-  /// \param object: offset into `expr` (may be unknown).
+  /// \param offset: offset into `expr` (may be unknown).
   bool insert(object_mapt &dest, const exprt &expr, const offsett &offset) const
   {
     return insert(dest, object_numbering.number(expr), offset);
diff --git a/unit/testing-utils/require_expr.cpp b/unit/testing-utils/require_expr.cpp
@@ -95,7 +95,7 @@ typecast_exprt require_expr::require_typecast(const exprt &expr)
 
 /// Verify a given exprt is a side_effect_exprt with appropriate statement.
 /// \param expr: The expression.
-/// \param symbol_name: The intended identifier of statement
+/// \param side_effect_statement: The kind of side effect that is required
 /// \return The expr cast to a side_effect_exprt
 side_effect_exprt require_expr::require_side_effect_expr(
   const exprt &expr,
