added documentation for error codes

pull/6/merge
Sergey Bakhurin 2020-05-14 23:43:13 +03:00
rodzic 6a5cf5f83f
commit 2bdad6b6a8
2 zmienionych plików z 58 dodań i 8 usunięć

Wyświetl plik

@ -49,6 +49,11 @@
\ingroup ERROR_CODE_GROUP
\def ERROR_FFT_SIZE
\brief Неверно задан размер БПФ.
Размер БПФ может быть составным вида
\f$n = n_0 \times n_1 \times n_2 \ldots \times n_p \times m\f$,
где \f$n_i = 2,3,5,7\f$, а \f$m \f$ --
произвольный простой множитель не превосходящий 46340.
Ошибка возникает, когда множитель \f$m \f$ превосходит 46340.
*/
@ -129,9 +134,16 @@
\ingroup ERROR_CODE_GROUP
\def ERROR_FILTER_WP
\brief Параметр частоты среза фильтра задан неверно.
Частота среза фильтра должна быть положительной от 0 до 1 для
цифрового КИХ-фильтра.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_FILTER_WS
\brief Параметр частоты заграждения фильтра задан неверно.
Частота заграждения должна быть положительным числом от 0 до 1.
*/
@ -149,18 +161,32 @@
\ingroup ERROR_CODE_GROUP
\def ERROR_FOPEN
\brief Ошибка открытия файла.
Файл с заданным именем не может быть открыт для записи и чтения.
Файл с заданным именем не может быть открыт для записи и (или) чтения.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_FFT_SIZE
\brief Неверно задан размер БПФ.
\def ERROR_FREAD_SIZE
\brief Ошибка чтения блока данных из бинарного файла.
Ошибка возникает, если при чтении блока данных из файла размер считанного блока
не соответствует требуемому значению.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_FWRITE_SIZE
\brief Ошибка записи блока данных в бинарный файла.
Ошибка возникает, если при записи блока данных в файл, размер записанного блока
не соответствует требуемому значению.
*/
/*!
@ -182,6 +208,33 @@
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_LAPACK
\brief Встроенная функция пакета LAPACK вернула код ошибки.
Данная ошибка возвращается функцией, если она использует одну из встроенных
функций LAPACK, которая завершилась с ошибкой.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_MATRIX_SIZE
\brief Неверный размер матрицы.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_MIN_MAX
\brief Минимальное значение (нижняя граница) больше максимального.
*/
/*!
\ingroup ERROR_CODE_GROUP
\def ERROR_PTR

Wyświetl plik

@ -125,14 +125,11 @@ typedef struct
#define ERROR_GNUPLOT_TERM 0x07161220
/* H 0x08xxxxxx*/
/* I 0x09xxxxxx*/
#define ERROR_INC_SIZE 0x09140319
/* J 0x10xxxxxx*/
/* K 0x11xxxxxx*/
/* L 0x12xxxxxx*/
#define ERROR_LAPACK 0x12011601
/* M 0x13xxxxxx*/
#define ERROR_MATRIX_INDEX 0x13010914
#define ERROR_MATRIX_SINGULAR 0x13011914
#define ERROR_MATRIX_SIZE 0x13011926
#define ERROR_MIN_MAX 0x13091413
/* N 0x14xxxxxx*/