Skip to content

Commit

Permalink
doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
camilo committed Dec 26, 2023
1 parent fc19242 commit b02fb43
Show file tree
Hide file tree
Showing 9 changed files with 42 additions and 15 deletions.
3 changes: 1 addition & 2 deletions src/include/bitfield.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ namespace qlibs {

/**
* @brief Determine the @c uint8_t array-size to setup a BitField instance.
* @param[in] nbits The desired number of bits for the BitField.
* @param[in] n The desired number of bits for the BitField.
* @return The number for bytes ( or array size for @c uint8_t ) required for
* the BitField of @a n bits
*/
Expand Down Expand Up @@ -126,7 +126,6 @@ namespace qlibs {

/**
* @brief Clears one bit in a BitField
* @param[in] b A pointer to the BitField instance
* @param[in] index The bit-index.
* @return @c true on success, otherwise return @c false.
*/
Expand Down
4 changes: 2 additions & 2 deletions src/include/fis.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

namespace qlibs {

/** @addtogroup qfis Fuzzy Inference System Engine
/** @addtogroup qfis Fuzzy Inference System Engine
* @brief API for the qFIS Fuzzy Inference System Engine
* @{
*/
Expand Down Expand Up @@ -1199,7 +1199,7 @@ namespace qlibs {
}
};

/** @}*/
/** @}*/

}

Expand Down
6 changes: 3 additions & 3 deletions src/include/generic.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ namespace qlibs {

/** @addtogroup qtypegeneric qTypeGeneric
* @brief Type-generic utilities
* @{
* @{
*/

/*! @cond */
/*! @cond */
using compareFcn_t = int (*)( const void *, const void *, void * );
using forEachFcn_t = int (* const)( int, void *, void * );
/*! @endcond */
/*! @endcond */

/**
* @brief Swaps the data pointed by @a x and @a y
Expand Down
6 changes: 3 additions & 3 deletions src/include/ltisys.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ namespace qlibs {
/** @addtogroup qltisys Recursive LTI systems evaluation by transfer functions
* @brief API for the qLTISys library for recursive evaluation of LTI systems
* defined by transfer functions
* @{
* @{
*/

enum ltisysType {
Expand Down Expand Up @@ -280,7 +280,7 @@ namespace qlibs {
*
* example 2: \f$ \frac{ b_{0}s^{2}+b_{1}s+b_{2} }{ a_{0}s^{2} + a_{1}s + a_{2} }, na = 3 \f$
* @note Size of @a num and @a den should be equal.
* @param[in] dt The time-step of the continuos system.
* @param[in] dT The time-step of the continuos system.
* @note By default, initial conditions are set to zero. To change the initial
* conditions to the desired values, use the
* continuousSystem::setInitStates() method.
Expand Down Expand Up @@ -312,7 +312,7 @@ namespace qlibs {
*
* example 2: \f$ \frac{ b_{0}s^{2}+b_{1}s+b_{2} }{ a_{0}s^{2} + a_{1}s + a_{2} }, na = 3 \f$
* @note Size of @a num and @a den should be equal.
* @param[in] dt The time-step of the continuos system.
* @param[in] dT The time-step of the continuos system.
* @return @c true on success, otherwise return @c false.
* @note By default, initial conditions are set to zero. To change the initial
* conditions to the desired values, use the
Expand Down
2 changes: 1 addition & 1 deletion src/include/mathex.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ namespace qlibs {

/** @addtogroup qfmathex qFMathEx
* @brief Extra floating-point math and analysis functions
* @{
* @{
*/

/**
Expand Down
4 changes: 2 additions & 2 deletions src/include/pid.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@

namespace qlibs {

/** @addtogroup qpid Closed Loop PID Controller library
/** @addtogroup qpid Closed Loop PID Controller library
* @brief API for the qPID Controller library
* @{
* @{
*/

/**
Expand Down
24 changes: 24 additions & 0 deletions src/include/smoother.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,12 @@ namespace qlibs {
*/
class smoother {
protected:
/*! @cond */
bool init{ true };
static void windowSet( real_t *w,
const size_t wsize,
const real_t x );
/*! @endcond */
public:
virtual ~smoother() {}

Expand Down Expand Up @@ -62,8 +64,10 @@ namespace qlibs {
*/
class smootherLPF1 : public smoother {
protected:
/*! @cond */
real_t alpha{ 0.9 };
real_t y1{ 0.0 };
/*! @endcond */
public:
virtual ~smootherLPF1() {}

Expand All @@ -89,6 +93,7 @@ namespace qlibs {
*/
class smootherLPF2 : public smoother {
protected:
/*! @cond */
real_t y1{ 0.0 };
real_t y2{ 0.0 };
real_t x1{ 0.0 };
Expand All @@ -97,6 +102,7 @@ namespace qlibs {
real_t a1{ 0.0 };
real_t a2{ 0.0 };
real_t b1{ 0.0 };
/*! @endcond */
public:
virtual ~smootherLPF2() {}

Expand All @@ -123,8 +129,10 @@ namespace qlibs {
*/
class smootherMWM1 : public smoother, private nonCopyable {
protected:
/*! @cond */
real_t *w{ nullptr };
size_t wsize{ 0U };
/*! @endcond */
public:
virtual ~smootherMWM1() {}

Expand Down Expand Up @@ -163,7 +171,9 @@ namespace qlibs {
*/
class smootherMWM2 : public smoother, public tdl {
protected:
/*! @cond */
real_t sum{ 0.0 };
/*! @endcond */
public:
virtual ~smootherMWM2() {}

Expand Down Expand Up @@ -202,10 +212,12 @@ namespace qlibs {
*/
class smootherMOR1 : public smoother, private nonCopyable {
protected:
/*! @cond */
real_t *w{ nullptr };
real_t m{ 0.0 };
real_t alpha{ 0.8 };
size_t wsize{ 0U };
/*! @endcond */
public:
virtual ~smootherMOR1() {}

Expand Down Expand Up @@ -248,9 +260,11 @@ namespace qlibs {
*/
class smootherMOR2 : public smoother, public tdl {
protected:
/*! @cond */
real_t sum{ 0.0 };
real_t m{ 0.0 };
real_t alpha{ 0.8 };
/*! @endcond */
public:
virtual ~smootherMOR2() {}

Expand Down Expand Up @@ -292,9 +306,11 @@ namespace qlibs {
*/
class smootherGMWF : public smoother, private nonCopyable {
protected:
/*! @cond */
real_t *w{ nullptr };
real_t *k{ nullptr };
size_t wsize;
/*! @endcond */
public:
virtual ~smootherGMWF() {}

Expand Down Expand Up @@ -346,9 +362,11 @@ namespace qlibs {
*/
class smootherEXPW : public smoother {
protected:
/*! @cond */
real_t lambda{ 0.8 };
real_t m{ 0U };
real_t w{ 1.0 };
/*! @endcond */
public:
virtual ~smootherEXPW() {}

Expand All @@ -373,13 +391,15 @@ namespace qlibs {
*/
class smootherKLMN : public smoother {
protected:
/*! @cond */
real_t xS{ 0.0 }; /* state */
real_t A{ 1.0 }; /* x(n)=A*x(n-1)+u(n),u(n)~N(0,q) */
real_t H{ 1.0 }; /* z(n)=H*x(n)+w(n),w(n)~N(0,r) */
real_t q{ 100.0 }; /* process(predict) noise covariance */
real_t r{ 0.9 }; /* measure noise covariance */
real_t p{ 100.0 }; /* estimated error covariance */
real_t gain;
/*! @endcond */
public:
virtual ~smootherKLMN() {}

Expand Down Expand Up @@ -408,11 +428,13 @@ namespace qlibs {
*/
class smootherDESF : public smoother {
protected:
/*! @cond */
real_t alpha;
real_t beta;
real_t lt;
real_t bt;
real_t n;
/*! @endcond */
public:

/**
Expand Down Expand Up @@ -441,12 +463,14 @@ namespace qlibs {
*/
class smootherALNF : public smoother, private nonCopyable {
protected:
/*! @cond */
real_t alpha;
real_t mu;
real_t *w{ nullptr };
real_t *w_1{ nullptr };
real_t *xx{ nullptr };
size_t n{ 0U };
/*! @endcond */
public:
virtual ~smootherALNF() {}

Expand Down
4 changes: 3 additions & 1 deletion src/include/tdl.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ namespace qlibs {
*/
class tdl : private nonCopyable {
protected:
/*! @cond */
real_t *head{ nullptr };
real_t *tail{ nullptr };
real_t *rd{ nullptr };
Expand All @@ -37,6 +38,7 @@ namespace qlibs {

void insertNewest( const real_t sample ) noexcept;
void removeOldest( void ) noexcept;
/*! @endcond */
public:
virtual ~tdl() {}
tdl() = default;
Expand Down Expand Up @@ -127,7 +129,7 @@ namespace qlibs {

/**
* @brief Get the specified delayed sample from the TDL x(k-i)
* @param[in] i The requested delay index
* @param[in] index The requested delay index
* @return The requested value from the TDL
*/
const real_t& operator[]( int index ) noexcept;
Expand Down
4 changes: 3 additions & 1 deletion src/include/types.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,13 +59,15 @@ namespace qlibs {
};
/*! @endcond */

/** @}*/

}

/*! @cond */
#define Q_UNUSED(arg) (void)(arg)
#define Q_NONE /*EMPTY MACRO*/
/*! @endcond */

/** @}*/


#endif /*QOS_CPP_TYPES*/

0 comments on commit b02fb43

Please sign in to comment.