diff --git a/trick_source/er7_utils/integration/beeman/src/beeman_integrator_constructor.cc b/trick_source/er7_utils/integration/beeman/src/beeman_integrator_constructor.cc index 02877bf7..72d2bf71 100644 --- a/trick_source/er7_utils/integration/beeman/src/beeman_integrator_constructor.cc +++ b/trick_source/er7_utils/integration/beeman/src/beeman_integrator_constructor.cc @@ -24,7 +24,7 @@ Purpose: () // Integration includes #include "er7_utils/integration/core/include/integrator_constructor_utils.hh" #include "er7_utils/integration/core/include/priming_integration_controls.hh" -#include "er7_utils/integration/rk2_heun/include/rk2_heun_integrator_constructor.hh" +#include "er7_utils/integration/rk2_heun/include/rk2_heun_first_order_ode_integrator.hh" // Model includes #include "../include/beeman_integrator_constructor.hh" diff --git a/trick_source/er7_utils/integration/core/include/generalized_position_derivative.hh b/trick_source/er7_utils/integration/core/include/generalized_position_derivative.hh index 5a31d532..71aec3a9 100644 --- a/trick_source/er7_utils/integration/core/include/generalized_position_derivative.hh +++ b/trick_source/er7_utils/integration/core/include/generalized_position_derivative.hh @@ -68,7 +68,7 @@ public: const double * ER7_UTILS_RESTRICT position, const double * ER7_UTILS_RESTRICT velocity, const double * ER7_UTILS_RESTRICT acceleration, - double * ER7_UTILS_RESTRICT position_second_derivative); + double * ER7_UTILS_RESTRICT position_2nd_derivative); // Constructors and destructor @@ -106,13 +106,17 @@ public: // Member data - FirstDerivative first_deriv_fun; /**< trick_io(**) @n - Function that computes the first time derivative of - generalized position. */ + /** + * Function that computes the first time derivative of + * generalized position. + */ + FirstDerivative first_deriv_fun; //!< trick_io(**) - SecondDerivative second_deriv_fun; /**< trick_io(**) @n - Function that computes the second time derivative of - generalized position. */ + /** + * Function that computes the second time derivative of + * generalized position. + */ + SecondDerivative second_deriv_fun; //!< trick_io(**) }; diff --git a/trick_source/er7_utils/integration/core/include/integration_controls.hh b/trick_source/er7_utils/integration/core/include/integration_controls.hh index 0fb403fd..927a05ef 100644 --- a/trick_source/er7_utils/integration/core/include/integration_controls.hh +++ b/trick_source/er7_utils/integration/core/include/integration_controls.hh @@ -228,7 +228,7 @@ protected: * IntegrationControls copy constructor. * @param[in] source The IntegrationControls to be copied. */ - IntegrationControls (const IntegrationControls &); + IntegrationControls (const IntegrationControls & source); /** * IntegrationControls non-default constructor. diff --git a/trick_source/er7_utils/integration/rkn4/include/rkn4_second_order_ode_integrator.hh b/trick_source/er7_utils/integration/rkn4/include/rkn4_second_order_ode_integrator.hh index 9ca9092e..00eb84f6 100644 --- a/trick_source/er7_utils/integration/rkn4/include/rkn4_second_order_ode_integrator.hh +++ b/trick_source/er7_utils/integration/rkn4/include/rkn4_second_order_ode_integrator.hh @@ -77,7 +77,7 @@ protected: * for a simple second order ODE, one in which generalized velocity * is time derivative of generalized position. * @param[in] size State size - * @param[in,out] controls_in Integration controls + * @param[in,out] controls Integration controls */ RKNystrom4SecondOrderODEIntegrator ( unsigned int size, diff --git a/trick_source/er7_utils/interface/include/alloc.hh b/trick_source/er7_utils/interface/include/alloc.hh index a3de577d..0bfa174e 100644 --- a/trick_source/er7_utils/interface/include/alloc.hh +++ b/trick_source/er7_utils/interface/include/alloc.hh @@ -173,7 +173,6 @@ namespace er7_utils { * Destruct and deallocate a previously allocated object. * @tparam T Type of the object to be deallocated. * @param obj Object to be destructed, as a reference to a pointer. - * @return Array of allocated objects. */ template inline void delete_object (T*& obj) { @@ -540,7 +539,7 @@ namespace er7_utils { /** * Deallocate an array of some primitive type - * @tparam T + * @tparam T Array type. * @param arr Array to be deallocated. */ template @@ -632,7 +631,7 @@ namespace er7_utils { * Allocate contents of a 2D array, where the array is declared as * @code T ** array @endcode * @tparam T Array type - * @tparam outer Array outer dimension + * @param outer Array outer dimension * @param inner Array inner dimension * @return Allocated 2D array. */ @@ -680,7 +679,6 @@ namespace er7_utils { /** * Specialization of replicate_2D_array for double. - * @tparam T Array type * @tparam M Array outer dimension * @param[in] size Array inner dimension * @param[in] src Source 2D array @@ -752,7 +750,6 @@ namespace er7_utils { /** * Specialization of deallocate_2D_array for double. - * @tparam T Array type * @tparam M Array outer dimension * @param[in,out] arr Array to be deallocated */ @@ -768,12 +765,11 @@ namespace er7_utils { /** * Deallocate a 2D array. * @tparam T Array type - * @tparam outer Array outer dimension * @param[in,out] arr Array to be deallocated */ template inline void deallocate_2D_array ( - unsigned int outer ER7_UTILS_UNUSED, + unsigned int, T **& arr) { if (arr != NULL) { diff --git a/trick_source/er7_utils/interface/include/type_traits.hh b/trick_source/er7_utils/interface/include/type_traits.hh index 92720711..667568ce 100644 --- a/trick_source/er7_utils/interface/include/type_traits.hh +++ b/trick_source/er7_utils/interface/include/type_traits.hh @@ -163,7 +163,8 @@ namespace er7_utils { * uses dynamic_cast. * @tparam T Type to be deduced. * This parameter is a polymorphic class in this base implementation. - * @tparam is_class True if T is a polymorphic class, false otherwise. + * @tparam is_polymorphic True if T is a polymorphic class, + * false otherwise. * This parameter is true in this base implementation. */ template diff --git a/trick_source/er7_utils/math/include/n_choose_m.hh b/trick_source/er7_utils/math/include/n_choose_m.hh index e996b0df..2686af55 100644 --- a/trick_source/er7_utils/math/include/n_choose_m.hh +++ b/trick_source/er7_utils/math/include/n_choose_m.hh @@ -76,7 +76,7 @@ public: /** * Resize the triangle if the current number of rows is less than the * specified size. - * @param new_triangle_nrows Requested number of rows in the triangle. + * @param new_size Requested number of rows in the triangle. * @throw std::overflow_error if new_triangle_nrows > 68. */ void resize (unsigned int new_size); diff --git a/trick_source/er7_utils/math/include/ratio128.hh b/trick_source/er7_utils/math/include/ratio128.hh index 17208034..107467f9 100644 --- a/trick_source/er7_utils/math/include/ratio128.hh +++ b/trick_source/er7_utils/math/include/ratio128.hh @@ -410,12 +410,12 @@ public: // Comparison operators. /** - * Returns a friend bool operator< (T a, const Ratio128 & b) @@ -424,7 +424,7 @@ public: } /** - * Returns a friend bool operator< (const Ratio128 & a, T b) diff --git a/trick_source/sim_services/CheckPointAgent/include/ClassicCheckPointAgent.hh b/trick_source/sim_services/CheckPointAgent/include/ClassicCheckPointAgent.hh index eeac175d..9f0a52b8 100644 --- a/trick_source/sim_services/CheckPointAgent/include/ClassicCheckPointAgent.hh +++ b/trick_source/sim_services/CheckPointAgent/include/ClassicCheckPointAgent.hh @@ -52,15 +52,15 @@ namespace Trick { @param address Address of the variable. @param attr ATTRIBUTES of the variable. - @param curr_dim - @param offset + @param curr_dim Dimensions of the array + @param offset Offset into the array */ void assign_rvalue( std::ostream& chkpnt_os, void* address, ATTRIBUTES* attr, int curr_dim, int offset); /** Restore memory allocations from a checkpoint stream. @param checkpoint_stream Input stream from which the checkpoint is read. - @return + @return 0/1 success flag */ int restore( std::istream* checkpoint_stream); @@ -72,7 +72,6 @@ namespace Trick { @param address - address of the object within which we are checking for nil values. @param attr - attr describing the object at the address. @param curr_dim - dimension of the sub-element being checked. - @param offset - offset of the sub-element @param offset - if the object specified by @b address and @b attr is arrayed, then this parameter specifies where, within the array, the sub-object to be checked, is located. @@ -86,7 +85,7 @@ namespace Trick { The pointer must be an address that is being managed by MM (the MemoryManager) or a character string (char* or wchar_t*). - @param pointer + @param pointer Pointer to be converted. @param attr ATTRIBUTES of the pointer. @param curr_dim current dimension. @return text expression that represents the pointer. diff --git a/trick_source/sim_services/Executive/include/sim_mode.h b/trick_source/sim_services/Executive/include/sim_mode.h index 258e35c9..aa1eb169 100644 --- a/trick_source/sim_services/Executive/include/sim_mode.h +++ b/trick_source/sim_services/Executive/include/sim_mode.h @@ -7,7 +7,7 @@ PROGRAMMERS: */ /** - * @class SIM_COMMAND sim_mode.h + * @enum SIM_COMMAND * The SIM_COMMAND enumeration represents the TRICK simulation commmands. */ @@ -24,7 +24,7 @@ typedef enum { } SIM_COMMAND; /** - * @class SIM_MODE sim_mode.h + * @enum SIM_MODE * The SIM_MODE enumeration represents the TRICK simulation modes. */ diff --git a/trick_source/sim_services/Integrator/include/IntegLoopManager.hh b/trick_source/sim_services/Integrator/include/IntegLoopManager.hh index 706c4111..7bd8afc2 100644 --- a/trick_source/sim_services/Integrator/include/IntegLoopManager.hh +++ b/trick_source/sim_services/Integrator/include/IntegLoopManager.hh @@ -84,7 +84,7 @@ class IntegLoopScheduler; * Designate the specified sim object as integrated by the specified * scheduler. * @param sim_object Simulation object. - * @param scheduler Integration loop scheduler. + * @param integrator Integration loop scheduler. */ void set_integrated_by ( Trick::SimObject * sim_object, diff --git a/trick_source/sim_services/Integrator/include/IntegLoopScheduler.hh b/trick_source/sim_services/Integrator/include/IntegLoopScheduler.hh index b38ce95e..6ecb9dd8 100644 --- a/trick_source/sim_services/Integrator/include/IntegLoopScheduler.hh +++ b/trick_source/sim_services/Integrator/include/IntegLoopScheduler.hh @@ -114,7 +114,7 @@ namespace Trick { /** * Non-default constructor. - * @param cycle The time interval at which the loop's integrate + * @param in_cycle The time interval at which the loop's integrate * function will be called. * @param parent_so The Trick simulation object that contains this * IntegLoopScheduler object. diff --git a/trick_source/sim_services/MemoryManager/include/MemoryManager.hh b/trick_source/sim_services/MemoryManager/include/MemoryManager.hh index 10de4479..5013e961 100644 --- a/trick_source/sim_services/MemoryManager/include/MemoryManager.hh +++ b/trick_source/sim_services/MemoryManager/include/MemoryManager.hh @@ -297,7 +297,7 @@ namespace Trick { /** Forget about the variable with the given name and deallocate the memory associated with it. - @param address - the address of the variable. + @param var_name - the address of the variable. @return 0 = SUCCESS, 1 = FAILURE */ int delete_var(const char* var_name); @@ -313,7 +313,7 @@ namespace Trick { /** Forget about the external variable with the given name. DOES NOT attempt to deallocate the memory at the given address. - @param address - the address of the external variable. + @param var_name - the address of the external variable. @return 0 = SUCCESS, 1 = FAILURE */ int delete_extern_var(const char* var_name); @@ -326,35 +326,35 @@ namespace Trick { /** Checkpoint all allocations known to the MemoryManager to a file. - @param filename + @param filename Name of file to be written. */ void write_checkpoint( const char* filename); /** Checkpoint the named variable (allocation) and it dependencies to the given stream. @param out_s output stream. - @param var_name + @param var_name Variable name. */ void write_checkpoint( std::ostream& out_s, const char* var_name); /** Checkpoint the named variable (allocation) and it dependencies to a file. - @param filename - @param var_name + @param filename Checkpoint file. + @param var_name Variable name. */ void write_checkpoint( const char* filename, const char* var_name); /** Checkpoint the named variables and their dependencies to a stream. @param out_s output stream. - @param var_name_list + @param var_name_list List of variable names. */ void write_checkpoint( std::ostream& out_s, std::vector& var_name_list); /** Checkpoint the named variables and their dependencies to a file. - @param filename - @param var_name_list + @param filename output file name. + @param var_name_list List of variable names. */ void write_checkpoint( const char* filename, std::vector& var_name_list); @@ -513,13 +513,13 @@ namespace Trick { /** Return the number of array elements in the allocation. - @param ptr address. + @param addr Address. */ int get_size(void *addr); /** Return the number of array elements in the allocation following ptr. - @param ptr - pointer. + @param addr Address. */ int get_truncated_size(void *addr); @@ -549,7 +549,7 @@ namespace Trick { /** Opens a handle to the shared library file. The handles are used to look for io_src functions. - @param name The name of the file to open. + @param file_name The name of the file to open. */ int add_shared_library_symbols( const char * file_name ); @@ -593,7 +593,7 @@ namespace Trick { Write the contents of the variable with the given name to the given stream. In other words, checkpoint a single variable to a file. @param out_s - output stream. - @param address - address of the variable. + @param var_name - Name of the variable. */ void write_var( std::ostream& out_s, const char* var_name ); @@ -758,16 +758,13 @@ namespace Trick { /** Call the default destructor for one or more instances of the named class. - @param class_name The name of the class to allocate. - @param num The number of instances to allocate. - @return The address of the allocation, or NULL on failure. + @param alloc_info The alloc_info struct that contains the address and type to delete. */ void io_src_destruct_class(ALLOC_INFO * alloc_info); /** Call the proper class/struct delete for the address given in the ALLOC_INFO struct. - @alloc_info The alloc_info struct that contains the address and type to delete. - @return none. + @param alloc_info The alloc_info struct that contains the address and type to delete. */ void io_src_delete_class(ALLOC_INFO * alloc_info); diff --git a/trick_source/sim_services/MemoryManager/include/parameter_types.h b/trick_source/sim_services/MemoryManager/include/parameter_types.h index 18769e60..e0286f45 100644 --- a/trick_source/sim_services/MemoryManager/include/parameter_types.h +++ b/trick_source/sim_services/MemoryManager/include/parameter_types.h @@ -6,7 +6,6 @@ extern "C" { #endif /** - * @class Trick::MemoryManager::TRICK_TYPE parameter_types.h * The TRICK_TYPE enumeration represents the Trick data types. */ typedef enum { diff --git a/trick_source/sim_services/Message/include/message_type.h b/trick_source/sim_services/Message/include/message_type.h index a767ac0f..a74a3aa8 100644 --- a/trick_source/sim_services/Message/include/message_type.h +++ b/trick_source/sim_services/Message/include/message_type.h @@ -6,7 +6,7 @@ extern "C" { #endif /** - * @class Trick::MessagePublisher::MESSAGE_TYPE message_proto.h + * @enum Trick::MessagePublisher::MESSAGE_TYPE * The MESSAGE_TYPE enumeration represents types of messages to publish, which corresponds to the displayed color of the message. */ typedef enum { diff --git a/trick_source/sim_services/ScheduledJobQueue/include/ScheduledJobQueue.hh b/trick_source/sim_services/ScheduledJobQueue/include/ScheduledJobQueue.hh index 9e6ab393..7fceb352 100644 --- a/trick_source/sim_services/ScheduledJobQueue/include/ScheduledJobQueue.hh +++ b/trick_source/sim_services/ScheduledJobQueue/include/ScheduledJobQueue.hh @@ -71,7 +71,7 @@ namespace Trick { /** * @brief Sets the curr_index to value. - * @param value - Value of index. + * @param ii - Value of index. * @return always 0. */ int set_curr_index( unsigned int ii ) ; @@ -122,8 +122,6 @@ namespace Trick { * @brief Adds the incoming instrumentation job before target job if specified, or all jobs in list. * Will reallocate list to accommodate additional instrumentation jobs. * @param instrumentation_job - name of the instrument job - * @param target_job - name of the target job, empty string means all jobs are to be instrumented - * @param in_event - instrumentation data to be stored with instrument job * @return number of insertions made */ int instrument_before(JobData * instrumentation_job) ; @@ -132,8 +130,6 @@ namespace Trick { * @brief Adds the incoming instrumentation job after target job if specified, or all jobs in the list. * Will reallocate list to accommodate additional instrumentation jobs. * @param instrumentation_job - name of the instrument job - * @param target_job - name of the target job, empty string means all jobs are to be instrumented - * @param in_event - instrumentation data to be stored with instrument job * @return number of insertions made */ int instrument_after(JobData * instrumentation_job) ; @@ -142,7 +138,6 @@ namespace Trick { * @brief Removes all jobs in the list that match the name job_name. * If in_event is specified, only remove this event's instrument job. * @param job_name - name of the instrument job - * @param in_event - instrumentation data to be stored with instrument job * @return always 0 */ int instrument_remove(std::string job_name) ; diff --git a/trick_source/sim_services/Scheduler/include/Scheduler.hh b/trick_source/sim_services/Scheduler/include/Scheduler.hh index b4062c7d..e0e37173 100644 --- a/trick_source/sim_services/Scheduler/include/Scheduler.hh +++ b/trick_source/sim_services/Scheduler/include/Scheduler.hh @@ -85,8 +85,6 @@ namespace Trick { * otherwise adds in_job before each job in the initialization and scheduled queues. * Requirement [@ref r_exec_instrument_0] * @param instrument_job - the instrument job - * @param target_job - name of the target job, empty string means all jobs are to be instrumented - * @param in_event - instrumentation data to be stored with instrument job * @return always 0 */ virtual int instrument_job_before(Trick::JobData * instrument_job ) = 0 ; @@ -96,8 +94,6 @@ namespace Trick { * otherwise adds in_job after each job in the initialization and scheduled queues. * Requirement [@ref r_exec_instrument_2] * @param instrument_job - the instrument job - * @param target_job - name of the target job, empty string means all jobs are to be instrumented - * @param in_event - instrumentation data to be stored with instrument job * @return always 0 */ virtual int instrument_job_after(Trick::JobData * instrument_job ) = 0 ; @@ -106,7 +102,6 @@ namespace Trick { * Removes an instrumentation job with the name in_job in the initialization and scheduled queues. * Requirement [@ref r_exec_instrument_3] * @param in_job - name of the instrument job - * @param in_event - instrumentation data to be searched for * @return always 0 */ virtual int instrument_job_remove(std::string in_job ) = 0 ; diff --git a/trick_source/sim_services/SimObject/include/JobData.hh b/trick_source/sim_services/SimObject/include/JobData.hh index e67e2f48..4d6a710a 100644 --- a/trick_source/sim_services/SimObject/include/JobData.hh +++ b/trick_source/sim_services/SimObject/include/JobData.hh @@ -179,7 +179,7 @@ namespace Trick { /** * Sets/Resets the static time_tic value - * @param time_tic_value - number of tics per second + * @param in_time_tic_value - number of tics per second * @return always 0 */ static int set_time_tic_value(long long in_time_tic_value) ; @@ -187,7 +187,6 @@ namespace Trick { /** * Sets/Resets the job cycle rate * @param rate - desired cycle rate in seconds - * @param time_tic_value - number of tics per second * @return always 0 */ virtual int set_cycle(double rate) ; @@ -214,10 +213,10 @@ namespace Trick { /** * Adds another job as a dependency to this job - * @param depend - JobData instance of depends_on job + * @param in_tag - JobData instance of depends_on job * @return always 0 */ - virtual int add_tag( std::string ) ; + virtual int add_tag( std::string in_tag) ; /** * Adds another job as a dependency to this job diff --git a/trick_source/sim_services/SimObject/include/SimObject.hh b/trick_source/sim_services/SimObject/include/SimObject.hh index 98910ce3..2ba6fe90 100644 --- a/trick_source/sim_services/SimObject/include/SimObject.hh +++ b/trick_source/sim_services/SimObject/include/SimObject.hh @@ -62,7 +62,7 @@ namespace Trick { * @param name - name of lower level SimObject * @return always 0 */ - int add_pre_component_object(SimObject *, std::string name) ; + int add_pre_component_object(SimObject * in_object, std::string name) ; /** * Includes a lower level SimObject where the lower level jobs are called after this SimObject @@ -70,7 +70,7 @@ namespace Trick { * @param name - name of lower level SimObject * @return always 0 */ - int add_post_component_object(SimObject *, std::string name) ; + int add_post_component_object(SimObject * in_object, std::string name) ; /** * Adds a job to the sim_object. This call is typically in the S_source.cpp file