added documentation for error codes

pull/6/merge
Sergey Bakhurin 2020-05-13 23:48:20 +03:00
rodzic a2f2d22a9b
commit 6a5cf5f83f
3 zmienionych plików z 77 dodań i 10 usunięć

Wyświetl plik

@ -6,6 +6,34 @@
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_ARG_PARAM
\brief Неверный параметр вызова программы.
Данная ошибка возникает, когда производится вызов программы с неверным
количеством параметров `argc` и указателем `argv`
на массив параметров вызова программы.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_DAT_TYPE
\brief Неверный тип данных.
Данная ошибка возникает при сохранении данных в бинарный файл, когда параметр,
задающий тип данных в памяти (вещественные или комплексные) задан неверно.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_DIV_ZERO
\brief Ошибка деления на ноль.
Функция возвращает данную ошибку, если в вычислительном алгоритме возникло
деление на ноль.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_ELLIP_MODULE
@ -16,6 +44,7 @@
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_FFT_SIZE
@ -23,6 +52,34 @@
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_FILTER_A0
\brief Параметр \f$a_0\f$ передаточной характеристики \f$H(z)\f$ цифрового
БИХ-фильтра не может быть равен нулю.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_FILTER_APPROX
\brief Неизвестный тип аппроксимации цифрового или аналогового фильтра.
Данная ошибка возникает при неверном задании масок типа цифрового БИХ-фильтра.
Библиотека поддерживает следущие аппроксимации: Баттерворта, Чебышева первого
рода, Чебышева второго рода и эллиптические.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_FILTER_FT
\brief Неверно заданы частоты преобразования ФНЧ-ПФ и ФНЧ-РФ.
Частотные маски полосовых и режекторных фильтров имеют две частоты среза
или частоты заграждения. При реализации частотных преобразований фильтров
необходимо задавать правую частоту среза меньше левой.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_FILTER_ORD
@ -31,6 +88,16 @@
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_FILTER_ORD_BP
\brief Порядок полосового или режекторного фильтра задан неверно.
Порядок полосового и режекторного фильтра должен быть задан
чётным положительным значением.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_FILTER_RP
@ -48,6 +115,15 @@
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_FILTER_TYPE
\brief Неизвестный тип фильтра.
Библиотека поддерживает следущие типы фильтров: ФНЧ, ФВЧ, полосовой и
режекторный.
*/
/*!
\ingroup ERROR_CODE_GROUP
@ -58,14 +134,6 @@
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_FILTER_A0
\brief Коэффициент \f$a_0\f$ знаменателя передаточной функции фильтра равен нулю.
Необходимо задать параметр \f$a_0\f$ отличным от нуля.
*/
/*!

Wyświetl plik

@ -102,7 +102,7 @@ int DSPL_API gnuplot_create(int argc, char* argv[],
/*******************************************************************************
Write Guplot Command
Write Gnuplot Command
*******************************************************************************/
void DSPL_API gnuplot_cmd(void* h, char* cmd)
{

Wyświetl plik

@ -104,7 +104,6 @@ typedef struct
/* E 0x05xxxxxx*/
#define ERROR_ELLIP_MODULE 0x05121315
/* F 0x06xxxxxx*/
#define ERROR_FFT_CREATE 0x06060318
#define ERROR_FFT_SIZE 0x06062021
#define ERROR_FILTER_A0 0x06090100
#define ERROR_FILTER_APPROX 0x06090116