Skip to content

Commit 6888862

Browse files
author
camilo
committed
doc fixes
1 parent 5995b02 commit 6888862

File tree

7 files changed

+34
-39
lines changed

7 files changed

+34
-39
lines changed

‎src/include/algorithm.hpp‎

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ namespace qlibs {
3131
* @brief Exchanges the values of a and b.
3232
* @param[in,out] x Object to be swapped.
3333
* @param[in,out] y Object to be swapped.
34-
* @return none.
3534
*/
3635
template <typename T>
3736
void swap( T& x, T& y ) noexcept
@@ -94,7 +93,6 @@ namespace qlibs {
9493
* @code{.c}
9594
* bool cmp( const T& a, const T& b );
9695
* @endcode
97-
* @return none.
9896
*/
9997
template<typename T, size_t n>
10098
void sort( T ( &array )[ n ],
@@ -144,7 +142,6 @@ namespace qlibs {
144142
* @param[in,out] array The array to reverse.
145143
* @param[in] first Initial position of the portion to reverse
146144
* @param[in] last Final position of the portion to reverse
147-
* @return none.
148145
*/
149146
template<typename T, size_t n>
150147
inline void reverse( T ( &array )[ n ],
@@ -168,7 +165,6 @@ namespace qlibs {
168165
* a right-rotation and a negative value a left-rotation.
169166
* @param[in,out] array The array to rotate.
170167
* @param[in] k Positions to rotate. Sign determines the rotate direction.
171-
* @return none.
172168
*/
173169
template<typename T, size_t n>
174170
void rotate( T ( &array )[ n ],
@@ -202,7 +198,6 @@ namespace qlibs {
202198
* @param[in] value The value to set all elements to.
203199
* @param[in] first Initial position of the portion to fill
204200
* @param[in] last Final position of the portion to fill
205-
* @return none.
206201
*/
207202
template<typename T, size_t n>
208203
inline void fill( T ( &array )[ n ],
@@ -315,7 +310,6 @@ namespace qlibs {
315310
* @param[in] new_value The value to use as replacement
316311
* @param[in] first Initial position of the portion to check
317312
* @param[in] last Final position of the portion to check
318-
* @return @c none.
319313
*/
320314
template<typename T, size_t n>
321315
inline void replace( T ( &array )[ n ],
@@ -342,7 +336,6 @@ namespace qlibs {
342336
* @param[in] new_value The value to use as replacement
343337
* @param[in] first Initial position of the portion to check
344338
* @param[in] last Final position of the portion to check
345-
* @return @c none.
346339
*/
347340
template<typename T, size_t n>
348341
inline void replace_if( T ( &array )[ n ],
@@ -426,7 +419,6 @@ namespace qlibs {
426419
* argument.
427420
* @param[in] first Initial position of the portion to check
428421
* @param[in] last Final position of the portion to check
429-
* @return none
430422
*/
431423
template<typename T, size_t n>
432424
inline void for_each( T ( &array )[ n ],

‎src/include/bitfield.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ namespace qlibs {
2525

2626
/**
2727
* @brief Variable that allocates block of bytes to hold @a N bits for a BitField .
28-
* @tparam[in] N The desired number of bits for the BitField.
28+
* @tparam [in] N The desired number of bits for the BitField.
2929
*/
3030
template <size_t N>
3131
using bitArea = uint8_t[ 4U*( ( ( N - 1U )/32U ) + 1U ) ];

‎src/include/ltisys.hpp‎

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,9 @@ namespace qlibs {
6767

6868
/**
6969
* @brief Constructor for the continuousTF class
70-
* @param[in] numerator An array of size <order> with the coefficients
70+
* @param[in] numerator An array of size @c order with the coefficients
7171
* of the numerator in descending powers of s.
72-
* @param[in] denominator An array of size <order> with the coefficients
72+
* @param[in] denominator An array of size @c order with the coefficients
7373
* of the denominator in descending powers of s.
7474
*/
7575
continuousTF( const real_t ( &numerator )[ order + 1 ], const real_t ( &denominator )[ order + 1 ] )
@@ -145,7 +145,7 @@ namespace qlibs {
145145
virtual real_t operator()(const real_t xInput) noexcept = 0;
146146
virtual size_t getNumberOfDelays() const noexcept = 0;
147147
};
148-
/** @cond **/
148+
/** @endcond **/
149149

150150
/**
151151
* @brief Delays the input by a specified amount of time. You can use this
@@ -228,9 +228,9 @@ namespace qlibs {
228228

229229
/**
230230
* @brief Constructor for the discreteTF class
231-
* @param[in] numerator An array of size <NB> with the coefficients
231+
* @param[in] numerator An array of size @c NB with the coefficients
232232
* of the numerator in descending powers of z.
233-
* @param[in] denominator An array of size <NA> with the coefficients
233+
* @param[in] denominator An array of size @c NA with the coefficients
234234
* of the denominator in descending powers of z.
235235
*/
236236
discreteTF( const real_t ( &numerator )[ NB ], const real_t ( &denominator)[ NA ] ) {
@@ -271,14 +271,24 @@ namespace qlibs {
271271
ltisys() = default;
272272

273273
/**
274-
* @brief Drives the LTI system recursively using the input signal provided
275-
* @pre Instance must be previously initialized.
276-
* @note The user must ensure that this function is executed in the
277-
* required sample time @a T or time step @a dt either by using a
278-
* HW or SW timer, a real time task or a timing service.
279-
* @param[in] u A sample of the input signal that excites the system
280-
* @return The system response.
274+
* @brief Drives the LTI system recursively using the provided input
275+
* sample.
276+
* @details This function evaluates the system response based on the
277+
* given input signal and the internal state of the system. It must
278+
* be called periodically with a fixed time step to maintain correct
279+
* system behavior.
280+
*
281+
* @pre The instance must be properly initialized before calling this method.
282+
*
283+
* @note The user is responsible for ensuring that this function is invoked at consistent
284+
* intervals equal to the system's time step @a dt. This timing should
285+
* be enforced using a hardware timer, software timer, real-time task,
286+
* or another reliable timing mechanism.
287+
*
288+
* @param[in] u A new input sample that excites (drives) the system.
289+
* @return The system's output (response) at the current time step.
281290
*/
291+
real_t excite( real_t u ) noexcept;
282292

283293
/**
284294
* @brief Drives the LTI system recursively using the provided input
@@ -298,9 +308,6 @@ namespace qlibs {
298308
* @param[in] u A new input sample that excites (drives) the system.
299309
* @return The system's output (response) at the current time step.
300310
*/
301-
real_t excite( real_t u ) noexcept;
302-
303-
/// @copydoc excite(real_t)
304311
real_t operator()( const real_t u ) {
305312
return excite( u );
306313
}
@@ -386,7 +393,6 @@ namespace qlibs {
386393
* @param[in] n_a Number of elements in @a den.
387394
*
388395
* example 1: \f$ a_{0}+a_{1}z^{-1}+a_{2}z^{-2}+a_{3}z^{-3}, na = 4 \f$
389-
* @return @c true on success, otherwise return @c false.
390396
* @note By default, initial conditions are set to zero. To change the initial
391397
* conditions to the desired values, use the
392398
* discreteSystem::setInitStates() method.
@@ -414,7 +420,6 @@ namespace qlibs {
414420
* an array of type discreteStates with max(na,nb) elements
415421
* The supplied array will be updated on every invocation of
416422
* discreteSystem::excite().
417-
* @return @c true on success, otherwise return @c false.
418423
* @note By default, initial conditions are set to zero. To change the initial
419424
* conditions to the desired values, use the
420425
* discreteSystem::setInitStates() method.

‎src/include/numa.hpp‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,6 @@ namespace qlibs {
6565
* @param[in] x0 initial condition at time t(0)
6666
* @param[in] sn_1 initial condition at time (t-1)
6767
* @param[in] sn_2 initial condition at time (t-2)
68-
* @return none
6968
*/
7069
nState( const real_t x0 = 0.0_re,
7170
const real_t sn_1 = 0.0_re,
@@ -79,7 +78,6 @@ namespace qlibs {
7978
* @param[in] x0 initial condition at time t(0)
8079
* @param[in] sn_1 initial condition at time (t-1)
8180
* @param[in] sn_2 initial condition at time (t-2)
82-
* @return none
8381
*/
8482
void init( const real_t x0 = 0.0_re,
8583
const real_t sn_1 = 0.0_re,
@@ -126,8 +124,6 @@ namespace qlibs {
126124
*
127125
* @note The effectiveness and accuracy of each method depend on the
128126
* signal characteristics and time step.
129-
*
130-
* @return @c true if the method was successfully set; @c false otherwise.
131127
*/
132128
inline void setIntegrationMethod( integrationMethod m ) noexcept
133129
{
@@ -151,8 +147,6 @@ namespace qlibs {
151147
*
152148
* @note Choose the method based on the required balance between
153149
* accuracy and latency.
154-
*
155-
* @return @c true if the method was successfully set; @c false otherwise.
156150
*/
157151
inline void setDerivationMethod( derivationMethod m ) noexcept
158152
{

‎src/include/pid.hpp‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,16 @@ namespace qlibs {
360360
const real_t y ) noexcept;
361361

362362

363-
/// @copydoc control(const real_t, const real_t)
363+
/**
364+
* @brief Computes the control action for given PID controller instance.
365+
* @pre Instance must be previously initialized by pidController::setup()
366+
* @note The user must ensure that this function is executed in the time
367+
* specified in @a dt either by using a HW or SW timer, a real time task,
368+
* or a timing service.
369+
* @param[in] w The reference value aka SetPoint.
370+
* @param[in] y The controlled variable aka Process-variable.
371+
* @return The control action.
372+
*/
364373
real_t operator()( const real_t w,
365374
const real_t y )
366375
{

‎src/include/smoother.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -438,6 +438,7 @@ namespace qlibs {
438438
real_t n;
439439
/*! @endcond */
440440
public:
441+
virtual ~smootherDESF() {}
441442

442443
/**
443444
* @brief Setup an initialize the Double exponential smoothing instance
@@ -446,7 +447,6 @@ namespace qlibs {
446447
* @param[in] nS Number of steps for the forecast
447448
* @return @c true on success, otherwise return @c false.
448449
*/
449-
virtual ~smootherDESF() {}
450450
bool setup( const real_t a,
451451
const real_t b,
452452
const size_t nS );

‎src/include/tdl.hpp‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,6 @@ namespace qlibs {
7777
* @param[in] area An array of size @a n where delays will be stored
7878
* @param[in] n The number of elements on @a area.
7979
* @param[in] initVal The value with which all TDL delays will be initialized
80-
* @return none
8180
*/
8281
void setup( real_t * const area,
8382
const size_t n,
@@ -88,7 +87,6 @@ namespace qlibs {
8887
* the default optimal parameters.
8988
* @param[in] area The array where delays will be stored
9089
* @param[in] initVal The value with which all TDL delays will be initialized
91-
* @return none
9290
*/
9391
template <size_t numberOfDelays>
9492
void setup( real_t (&area)[ numberOfDelays ],
@@ -100,7 +98,6 @@ namespace qlibs {
10098
/**
10199
* @brief Clears all delays from the TDL and sets them to the specified value
102100
* @param[in] initVal The value with which all TDL delays will be initialized
103-
* @return none
104101
*/
105102
void flush( const real_t initVal = 0.0_re ) noexcept;
106103

@@ -126,7 +123,6 @@ namespace qlibs {
126123
/**
127124
* @brief Insert a new sample to the TDL removing the oldest sample
128125
* @param[in] sample The new sample to insert.
129-
* @return none
130126
*/
131127
void insertSample( const real_t sample ) noexcept;
132128

@@ -140,7 +136,6 @@ namespace qlibs {
140136
/**
141137
* @brief Insert a new sample to the TDL removing the oldest sample
142138
* @param[in] sample The new sample to insert.
143-
* @return none
144139
*/
145140
void operator()( const real_t sample ) noexcept
146141
{

0 commit comments

Comments
 (0)