rename doc macros
This commit is contained in:
@@ -1,5 +1,5 @@
|
||||
/*! \file picrc.h
|
||||
* \brief CRC checksum calculator
|
||||
/*! @file picrc.h
|
||||
* @brief CRC checksum calculator
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
|
||||
@@ -21,7 +21,7 @@
|
||||
|
||||
|
||||
/*! \class PIEvaluator
|
||||
* \brief This class provide mathematical evaluations of custom expression
|
||||
* @brief This class provide mathematical evaluations of custom expression
|
||||
*
|
||||
* \section PIEvaluator_sec0 Synopsis
|
||||
* %PIEvaluator developed for stream evaluations of once set expression.
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*! \file pievaluator.h
|
||||
* \brief Mathematic expressions calculator
|
||||
/*! @file pievaluator.h
|
||||
* @brief Mathematic expressions calculator
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*! \file pifft.h
|
||||
* \brief Class for FFT, IFFT and Hilbert transformations
|
||||
/*! @file pifft.h
|
||||
* @brief Class for FFT, IFFT and Hilbert transformations
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*! \file pigeometry.h
|
||||
* \brief Geometry base class
|
||||
/*! @file pigeometry.h
|
||||
* @brief Geometry base class
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*! \file pimathbase.h
|
||||
* \brief Basic mathematical functions and defines
|
||||
/*! @file pimathbase.h
|
||||
* @brief Basic mathematical functions and defines
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*! \file pimathcomplex.h
|
||||
* \brief PIP math complex
|
||||
/*! @file pimathcomplex.h
|
||||
* @brief PIP math complex
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*! \file pimathmatrix.h
|
||||
* \brief PIMathMatrix
|
||||
/*! @file pimathmatrix.h
|
||||
* @brief PIMathMatrix
|
||||
*
|
||||
* This file declare math matrix class, which performs various matrix operations
|
||||
*/
|
||||
@@ -37,7 +37,7 @@
|
||||
|
||||
#pragma pack(push, 1)
|
||||
|
||||
//! \brief A class that works with square matrix operations, the input data of which are columns, rows and the data type of the matrix
|
||||
//! @brief A class that works with square matrix operations, the input data of which are columns, rows and the data type of the matrix
|
||||
//! @tparam Rows rows number of matrix
|
||||
//! @tparam Сols columns number of matrix
|
||||
//! @tparam Type is the data type of the matrix. There are can be basic C++ language data and different classes where the arithmetic operators(=, +=, -=, *=, /=, ==, !=, +, -, *, /)
|
||||
@@ -156,8 +156,8 @@ public:
|
||||
* @brief Method which changes selected rows in a matrix.
|
||||
* If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
*
|
||||
* @param r0 is the number of the first selected row
|
||||
* @param r1 is the number of the second selected row
|
||||
* @param rf is the number of the first selected row
|
||||
* @param rs is the number of the second selected row
|
||||
* @return matrix type _CMatrix
|
||||
*/
|
||||
_CMatrix &swapRows(uint rf, uint rs) {
|
||||
@@ -169,8 +169,8 @@ public:
|
||||
* @brief Method which changes selected columns in a matrix.
|
||||
* If you enter an index out of the border of the matrix there will be "undefined behavior"
|
||||
*
|
||||
* @param c0 is the number of the first selected column
|
||||
* @param c1 is the number of the second selected column
|
||||
* @param cf is the number of the first selected column
|
||||
* @param cs is the number of the second selected column
|
||||
* @return matrix type _CMatrix
|
||||
*/
|
||||
_CMatrix &swapCols(uint cf, uint cs) {
|
||||
@@ -524,6 +524,11 @@ public:
|
||||
return tm;
|
||||
}
|
||||
|
||||
/**
|
||||
* @brief Matrix rotation operation. Works only with 2x2 matrix
|
||||
*
|
||||
* @return rotated matrix
|
||||
*/
|
||||
_CMatrix rotate(Type angle) {
|
||||
static_assert(Rows == 2 && Cols == 2, "Works only with 2x2 matrix");
|
||||
Type c = std::cos(angle);
|
||||
@@ -684,7 +689,7 @@ class PIMathMatrix;
|
||||
#define PIMM_FOR_C for (uint i = 0; i < _V2D::cols_; ++i)
|
||||
#define PIMM_FOR_R for (uint i = 0; i < _V2D::rows_; ++i)
|
||||
|
||||
//! \brief A class that works with matrix operations, the input data of which is the data type of the matrix
|
||||
//! @brief A class that works with matrix operations, the input data of which is the data type of the matrix
|
||||
//! @tparam There are can be basic C++ language data and different classes where the arithmetic operators(=, +=, -=, *=, /=, ==, !=, +, -, *, /)
|
||||
//! of the C++ language are implemented
|
||||
template<typename Type>
|
||||
@@ -1258,7 +1263,7 @@ inline PIMathVector<Type> operator*(const PIMathVector<Type> &sv,
|
||||
* @brief Multiplying value of type Type and matrix
|
||||
*
|
||||
* @param x first multiplier of type Type
|
||||
* @param fm second matrix multiplier
|
||||
* @param v second matrix multiplier
|
||||
* @return matrix that is the result of multiplication
|
||||
*/
|
||||
template<typename Type>
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*! \file pimathsolver.h
|
||||
* \brief PIMathSolver
|
||||
/*! @file pimathsolver.h
|
||||
* @brief PIMathSolver
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*! \file pimathvector.h
|
||||
* \brief PIMathVector
|
||||
/*! @file pimathvector.h
|
||||
* @brief PIMathVector
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*! \file piquaternion.h
|
||||
* \brief Class for quaternions
|
||||
/*! @file piquaternion.h
|
||||
* @brief Class for quaternions
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
/*! \file pistatistic.h
|
||||
* \brief Class for calculating math statistic in values array
|
||||
/*! @file pistatistic.h
|
||||
* @brief Class for calculating math statistic in values array
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
|
||||
Reference in New Issue
Block a user