doc groups
This commit is contained in:
+37
-2
@@ -1,6 +1,10 @@
|
||||
/*! \file pifft.h
|
||||
* \brief Class for FFT, IFFT and Hilbert transformations
|
||||
*/
|
||||
* \ingroup Math
|
||||
* \ingroup FFTW
|
||||
* \~\brief
|
||||
* \~english FFT, IFFT and Hilbert transformations
|
||||
* \~russian БПФ, ОБПФ и преобразования Гильберта
|
||||
*/
|
||||
/*
|
||||
PIP - Platform Independent Primitives
|
||||
Class for FFT, IFFT and Hilbert transformations
|
||||
@@ -19,6 +23,37 @@
|
||||
You should have received a copy of the GNU Lesser General Public License
|
||||
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
//! \defgroup FFTW
|
||||
//! \~\brief
|
||||
//! \~english Optimized FFT support via libfftw3
|
||||
//! \~russian Оптимизированный БПФ с помощью libfftw3
|
||||
//!
|
||||
//! \~\details
|
||||
//! \~english \section cmake_module Building with CMake
|
||||
//! \~russian \section cmake_module Сборка с использованием CMake
|
||||
//!
|
||||
//! \code
|
||||
//! find_package(PIP REQUIRED)
|
||||
//! target_link_libraries([target] PIP::FFTW)
|
||||
//! \endcode
|
||||
//!
|
||||
//! \~english \par Common
|
||||
//! \~russian \par Общее
|
||||
//!
|
||||
//! \~english
|
||||
//! These files provides FFT using [libfftw3](https://fftw.org/)
|
||||
//!
|
||||
//! \~russian
|
||||
//! Эти файлы обеспечивают БПФ с использованием [libfftw3](https://fftw.org/)
|
||||
//!
|
||||
//! \~\authors
|
||||
//! \~english
|
||||
//! Ivan Pelipenko peri4ko@yandex.ru;
|
||||
//! Andrey Bychkov work.a.b@yandex.ru;
|
||||
//! \~russian
|
||||
//! Иван Пелипенко peri4ko@yandex.ru;
|
||||
//! Андрей Бычков work.a.b@yandex.ru;
|
||||
//!
|
||||
|
||||
#ifndef PIFFT_H
|
||||
#define PIFFT_H
|
||||
|
||||
Reference in New Issue
Block a user