Skip to content

Commit 5598cb6

Browse files
author
camilo
committed
doc fixes
1 parent 2b5715f commit 5598cb6

File tree

3 files changed

+4
-10
lines changed

3 files changed

+4
-10
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,6 @@ Below is the list of the classes and modules provided and their features:
5656
- bitfield: A bit-field manipulation library
5757
- tdl : Tapped Delay Line in O(1).
5858
- rms : Recursive Root Mean Square(RMS) calculation of a signal.
59-
- Type-generic array operations
59+
- Type-generic utilities
6060
- Fast single-precision floating-point math
6161
- 1D Interpolation class

doc/mainpage.dox

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
* - @subpage qrms_desc "RMS : Recursive Root Mean Square (RMS) calculation"
3838
* - @subpage qcrc_desc "CRC : Generic Cyclic Redundancy Check (CRC) calculator"
3939
* - @subpage qtdl_desc "TDL : Tapped Delay Line in O(1)"
40-
* - Type-generic array operations
40+
* - Type-generic utilities
4141
* - Fast floating-point math library
4242
* - @subpage qinterp1_desc "1D Interpolation class"
4343
*/

src/include/mat.hpp

+2-8
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
* @author J. Camilo Gomez C.
44
* @version 1.01
55
* @note This file is part of the qLibs-cpp distribution.
6-
* @brief Computes the RMS (Root Mean Square) of a signal using a 2-step
7-
* recursive average specially designed for micro-controllers with FPU.
6+
* @brief Matrix library : under construction
87
**/
98

109
#ifndef QLIBS_MAT
@@ -18,11 +17,6 @@
1817
*/
1918
namespace qlibs {
2019

21-
/** @addtogroup qmat Matrix library
22-
* @brief Class for Recursive Root Mean Square RMS estimation
23-
* @{
24-
*/
25-
2620
enum matSpecial {
2721
MAT_ZERO,
2822
MAT_IDENTITY,
@@ -202,7 +196,7 @@ namespace qlibs {
202196
return result;
203197
}
204198

205-
// Overload the divison operator for scalar / matrix
199+
// Overload the division operator for scalar / matrix
206200
//friend mat<Rows, Cols> operator/(const real_t& scalar, const mat<Rows, Cols>& matrix)
207201
//{
208202
// mat<Rows, Cols> result;

0 commit comments

Comments
 (0)