dosygen merging

Changes to be committed:
	new file:   dspl/dox/ru/getting_started_make.dox
	modified:   dspl/dox/ru/getting_started_toolchain.dox
	modified:   dspl/dox/ru/mainpage.dox
pull/6/merge
Dsplib 2020-01-09 22:35:04 +03:00
rodzic a52ef6a59d
commit 10d0354f33
3 zmienionych plików z 96 dodań i 68 usunięć

Wyświetl plik

@ -0,0 +1,57 @@
/*! \page getting_started_make Компиляция libdspl-2.0 утилитой make
Предварительно необходимо установить все необходимые утилиты.
Если этот шаг не сделан, то смотри раздел: \n \n
\ref getting_started_toolchain
\n
\n
Скачиваем с сайта Github.com
<a href="https://github.com/Dsplib/libdspl-2.0">
сайта Github.com
</a>
исходные коды DSPL:
\image html dspl_github.png
Разархивируем в рабочий каталог.
Вы можете разархивировать в любой каталог, `libdspl-2.0` будет
обозначать каталог, в который разархивированы исходные коды.
В качестве примера, исходные коды были разархивированы в
каталог `J:\libdspl-2.0`. \n
Переходим в указанный каталог: \n
\image html libdspl_dir.png
Выделяем в строку адреса и вводим туда `cmd`: \n
\image html libdspl_cmd.png
В результате откроется консоль Windows в которую можно вводить команды. \n
Вводим команду `ming32-make`:\n
\image html winconsole_1.png
После нажатия `[Enter]` начнется сборка всех компонент библиотеки.
\note Время первой сборки зависит от производительности компьютера и может
занимать от двух до двадцати минут. Последующие сборки будут значительно
быстрее, потому что при первой сборке компилируются библиотеки BLAS и
LAPACK, которые линкуются в дальнейшем из готовых объектных файлов.
После сборки проекта можно перейти в каталог `bin` в котором сохранены
программы примеры. Также в данном каталоге можно найти готовую библиотеку
`libdspl.dll`:
\image html libdspl_bin.png
На этом установка всех компонент и сборка проекта окончена.
*/

Wyświetl plik

@ -1,20 +1,18 @@
/*! \page getting_started_toolchain Быстрый старт использования библиотеки в системе Windows
/*! \page getting_started_toolchain Установка DSPLIB toolchain в системе Windows
\tableofcontents
Запуск DSPL в системе Windows требует установки компилятора, Unix-утилит, и
пакета построения графиков GNUPlot. Также желательно установить консольный
файловый менеджер Far и IDE для разработки и отладки программ.
файловый менеджер Far и IDE для разработки и отладки программ. \n
Для установки всего необходимого софта предлагается скачать и установить
DSPLIB toolchain - полный набор утилит необходимых для работы с библиотекой.
DSPLIB toolchain - полный набор утилит необходимых для работы с библиотекой. \n
<a href = "http://ru.dsplib.org/dsplib_toolchain_19_10_win_x64.exe">
Скачать установщик dsplib_toolchain_19_10_win_x64.exe
</a> (~217 МБ).
\subsection install_gcc Установка DSPLIB toolchain в системе Windows
<a name = "install_toolchain"></a>
<h2> DSPLIB toolchain в системе Windows </h2>
@ -67,42 +65,14 @@ PATH, а на рабочем столе будут созданы иконки F
сборке библиотеки DSPL.
Теперь вы можете производить сборку библиотеки и работать с ней. \n \n
\subsection compile_gcc Компиляция libdspl-2.0 утилитой make
<a name = "compile_gcc"></a>
<h2>Компиляция libdspl-2.0 утилитой make</h2>
Скачиваем с сайта Github.com
<a href="https://github.com/Dsplib/libdspl-2.0">
сайта Github.com
</a>
исходные коды DSPL:
\image html dspl_github.png
Разархивируем в рабочий каталог.
Вы можете разархивировать в любой каталог, `libdspl-2.0` будет
обозначать каталог, в который разархивированы исходные коды.
В качестве примера, исходные коды были разархивированы в
каталог `J:\libdspl-2.0`. \n
Переходим в указанный каталог: \n
\image html libdspl_dir.png
Выделяем в строку адреса и вводим туда `cmd`: \n
\image html libdspl_cmd.png
В результате откроется консоль Windows в которую можно вводить команды. \n
Вводим команду `ming32-make`:\n
\image html winconsole_1.png
Смотри также: \n
\ref getting_started_make
\n \n
*/

Wyświetl plik

@ -3,7 +3,7 @@
\mainpage DSPL-2.0 - библиотека алгоритмов цифровой обработки сигналов.
DSPL-2.0 - свободная библиотека алгоритмов цифровой обработки сигналов,
с открытым исходным кодом, написанная на языке Си.<BR>
с открытым исходным кодом, написанная на языке Си.\n
Распространяется под лицензией
<a href = "http://www.gnu.org/licenses/lgpl.html">LGPL v3.</a>
@ -12,13 +12,14 @@ DSPL-2.0 - свободная библиотека алгоритмов цифр
Исходные коды библиотеки доступны на
<a href = "https://github.com/Dsplib/libdspl-2.0">GitHub</a>.<BR>
<a href = "https://github.com/Dsplib/libdspl-2.0">GitHub</a>.\n
Вы также можете внести свой вклад в развитие данной библиотеки. Присоединяйтесь!
Для начала работы с библиотекой необходимо ознакомиться с разделом:
\ref getting_started_toolchain <BR>
Для начала работы с библиотекой необходимо ознакомиться с разделами: \n \n
\ref getting_started_toolchain \n
\ref getting_started_make \n
<H3>
Содержание документации:
@ -26,33 +27,33 @@ DSPL-2.0 - свободная библиотека алгоритмов цифр
\ref TYPES_GROUP <BR>
\ref TYPES_GROUP \n
<B>Математические функции представлены следующими разделами:</B> <BR>
\ref SPEC_MATH_COMMON_GROUP <BR>
\ref SPEC_MATH_TRIG_GROUP <BR>
\ref SPEC_MATH_TRANSCEND <BR>
\ref SPEC_MATH_ELLIP_GROUP <BR>
\ref SPEC_MATH_RAND_GEN_GROUP <BR>
\ref SPEC_MATH_STAT_GROUP <BR>
\ref SPEC_MATH_LINALG_GROUP <BR><BR>
<B>Математические функции представлены следующими разделами:</B> \n
\ref SPEC_MATH_COMMON_GROUP \n
\ref SPEC_MATH_TRIG_GROUP \n
\ref SPEC_MATH_TRANSCEND \n
\ref SPEC_MATH_ELLIP_GROUP \n
\ref SPEC_MATH_RAND_GEN_GROUP \n
\ref SPEC_MATH_STAT_GROUP \n
\ref SPEC_MATH_LINALG_GROUP \n \n
<B>Алгоритмы спектрального анализа:</B><BR>
\ref DFT_GROUP <BR>
\ref WIN_GROUP <BR>
\ref HILBERT_GROUP <BR>
<B>Алгоритмы спектрального анализа:</B>\n
\ref DFT_GROUP \n
\ref WIN_GROUP \n
\ref HILBERT_GROUP \n \n
<B>Расчет и анализ аналоговых и цифровых фильтров:</B><BR>
\ref FILTER_CONV_GROUP <BR>
\ref IIR_FILTER_DESIGN_GROUP <BR>
\ref FIR_FILTER_DESIGN_GROUP <BR>
\ref FILTER_ANALYSIS_GROUP <BR>
<B>Расчет и анализ аналоговых и цифровых фильтров:</B>\n
\ref FILTER_CONV_GROUP \n
\ref IIR_FILTER_DESIGN_GROUP \n
\ref FIR_FILTER_DESIGN_GROUP \n
\ref FILTER_ANALYSIS_GROUP \n
<B>Прочие алгоритмы:</B><BR>
\ref RESAMPLING_GROUP <BR>
\ref IN_OUT_GROUP <BR>
<B>Прочие алгоритмы:</B> \n
\ref RESAMPLING_GROUP \n
\ref IN_OUT_GROUP \n
<BR>
\ref ERROR_CODE_GROUP <BR>
\n
\ref ERROR_CODE_GROUP \n
*/