diff --git a/libs/main/cloud/picloudmodule.h b/libs/main/cloud/picloudmodule.h index 16d78813..f54e20ca 100644 --- a/libs/main/cloud/picloudmodule.h +++ b/libs/main/cloud/picloudmodule.h @@ -25,7 +25,7 @@ //! \~english \section cmake_module_Cloud Building with CMake //! \~russian \section cmake_module_Cloud Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP::Cloud) //! \endcode diff --git a/libs/main/code/picodemodule.h b/libs/main/code/picodemodule.h index 0034d79e..97a3bb30 100644 --- a/libs/main/code/picodemodule.h +++ b/libs/main/code/picodemodule.h @@ -25,7 +25,7 @@ //! \~english \section cmake_module_Code Building with CMake //! \~russian \section cmake_module_Code Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP) //! \endcode diff --git a/libs/main/compress/picompress.h b/libs/main/compress/picompress.h index 85b0bfbf..dcd18b06 100644 --- a/libs/main/compress/picompress.h +++ b/libs/main/compress/picompress.h @@ -32,7 +32,7 @@ //! \~english \section cmake_module_Compress Building with CMake //! \~russian \section cmake_module_Compress Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP::Compress) //! \endcode diff --git a/libs/main/console/piconsolemodule.h b/libs/main/console/piconsolemodule.h index f2a44aaf..b3b3cf24 100644 --- a/libs/main/console/piconsolemodule.h +++ b/libs/main/console/piconsolemodule.h @@ -25,7 +25,7 @@ //! \~english \section cmake_module_Console Building with CMake //! \~russian \section cmake_module_Console Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP::Console) //! \endcode diff --git a/libs/main/core/picoremodule.h b/libs/main/core/picoremodule.h index 785acafc..1566078a 100644 --- a/libs/main/core/picoremodule.h +++ b/libs/main/core/picoremodule.h @@ -25,7 +25,7 @@ //! \~english \section cmake_module_Core Building with CMake //! \~russian \section cmake_module_Core Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP) //! \endcode diff --git a/libs/main/crypt/picryptmodule.h b/libs/main/crypt/picryptmodule.h index 926d3511..7f6dbe44 100644 --- a/libs/main/crypt/picryptmodule.h +++ b/libs/main/crypt/picryptmodule.h @@ -25,7 +25,7 @@ //! \~english \section cmake_module_Crypt Building with CMake //! \~russian \section cmake_module_Crypt Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP::Crypt) //! \endcode diff --git a/libs/main/geo/pigeomodule.h b/libs/main/geo/pigeomodule.h index 4e722b2f..e9b36cba 100644 --- a/libs/main/geo/pigeomodule.h +++ b/libs/main/geo/pigeomodule.h @@ -25,7 +25,7 @@ //! \~english \section cmake_module_Geo Building with CMake //! \~russian \section cmake_module_Geo Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP) //! \endcode diff --git a/libs/main/introspection/piintrospection_base.h b/libs/main/introspection/piintrospection_base.h index 3f090add..59a6349d 100644 --- a/libs/main/introspection/piintrospection_base.h +++ b/libs/main/introspection/piintrospection_base.h @@ -25,7 +25,7 @@ //! \~english \section cmake_module_Introspection Building with CMake //! \~russian \section cmake_module_Introspection Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP) //! \endcode diff --git a/libs/main/io_devices/piiodevicesmodule.h b/libs/main/io_devices/piiodevicesmodule.h index 60063b68..b3463b72 100644 --- a/libs/main/io_devices/piiodevicesmodule.h +++ b/libs/main/io_devices/piiodevicesmodule.h @@ -25,7 +25,7 @@ //! \~english \section cmake_module_IO Building with CMake //! \~russian \section cmake_module_IO Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP) //! \endcode diff --git a/libs/main/io_devices/piusb.h b/libs/main/io_devices/piusb.h index bfefdbb6..c54889c0 100644 --- a/libs/main/io_devices/piusb.h +++ b/libs/main/io_devices/piusb.h @@ -31,7 +31,7 @@ //! \~english \section cmake_module_USB Building with CMake //! \~russian \section cmake_module_USB Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP::USB) //! \endcode diff --git a/libs/main/io_utils/piioutilsmodule.h b/libs/main/io_utils/piioutilsmodule.h index 08822d9c..50cf247a 100644 --- a/libs/main/io_utils/piioutilsmodule.h +++ b/libs/main/io_utils/piioutilsmodule.h @@ -25,7 +25,7 @@ //! \~english \section cmake_module_IO_Utils Building with CMake //! \~russian \section cmake_module_IO_Utils Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP::IOUtils) //! \endcode diff --git a/libs/main/lua/pip_lua.h b/libs/main/lua/pip_lua.h index c24c98e6..aa8f36ae 100644 --- a/libs/main/lua/pip_lua.h +++ b/libs/main/lua/pip_lua.h @@ -31,7 +31,7 @@ //! \~english \section cmake_module_Lua Building with CMake //! \~russian \section cmake_module_Lua Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP::Lua) //! \endcode diff --git a/libs/main/math/pifft.h b/libs/main/math/pifft.h index 28ff1540..3c07702f 100644 --- a/libs/main/math/pifft.h +++ b/libs/main/math/pifft.h @@ -32,7 +32,7 @@ //! \~english \section cmake_module_FFTW Building with CMake //! \~russian \section cmake_module_FFTW Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP::FFTW) //! \endcode diff --git a/libs/main/math/pimathmodule.h b/libs/main/math/pimathmodule.h index 659d2eab..05b7f8f0 100644 --- a/libs/main/math/pimathmodule.h +++ b/libs/main/math/pimathmodule.h @@ -25,7 +25,7 @@ //! \~english \section cmake_module_Math Building with CMake //! \~russian \section cmake_module_Math Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP) //! \endcode diff --git a/libs/main/opencl/piopencl.h b/libs/main/opencl/piopencl.h index fc50b235..bdf761b9 100644 --- a/libs/main/opencl/piopencl.h +++ b/libs/main/opencl/piopencl.h @@ -31,7 +31,7 @@ //! \~english \section cmake_module_OpenCL Building with CMake //! \~russian \section cmake_module_OpenCL Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP::OpenCL) //! \endcode diff --git a/libs/main/resources/piresources.h b/libs/main/resources/piresources.h index 283406f7..b274a01e 100644 --- a/libs/main/resources/piresources.h +++ b/libs/main/resources/piresources.h @@ -31,7 +31,7 @@ //! \~english \section cmake_module_Resources Building with CMake //! \~russian \section cmake_module_Resources Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP) //! \endcode diff --git a/libs/main/system/piprocess.h b/libs/main/system/piprocess.h index 16f55225..8719a10c 100644 --- a/libs/main/system/piprocess.h +++ b/libs/main/system/piprocess.h @@ -2,7 +2,7 @@ * \ingroup System * \~\brief * \~english External process - * \~russian Внешний процесс + * \~russian Внешний процесс */ /* PIP - Platform Independent Primitives @@ -45,11 +45,11 @@ public: //! \~english Returns last attached execution exit code - //! \~russian + //! \~russian Возвращает код завершения последнего выполнения int exitCode() const {return exit_code;} //! \~english Returns current attached execution process ID - //! \~russian + //! \~russian Возвращает ID процесса текущего выполнения int pID() const; void setGrabInput(bool yes) {g_in = yes;} @@ -162,22 +162,27 @@ public: //! \{ //! \fn void exec(const PIString & program) + //! \brief //! \~english Start attached execution "program" without arguments //! \~russian //! \fn void exec(const PIString & program, const PIStringList & args) + //! \brief //! \~english Start attached execution "program" with arguments "args" //! \~russian //! \fn void terminate() + //! \brief //! \~english Immediately terminate attached execution //! \~russian //! \fn bool waitForFinish() + //! \brief //! \~english Wait for attached execution finish maximum for 60 seconds //! \~russian //! \fn bool waitForFinish(int timeout_msecs) + //! \brief //! \~english Wait for attached execution finish maximum for "timeout_msecs" milliseconds //! \~russian @@ -186,10 +191,12 @@ public: //! \{ //! \fn void execStarted(PIString program) + //! \brief //! \~english Raise on attached execution start //! \~russian //! \fn void execFinished(PIString program) + //! \brief //! \~english Raise on attached execution finish //! \~russian diff --git a/libs/main/system/pisystemmodule.h b/libs/main/system/pisystemmodule.h index cbe6de4e..199e15db 100644 --- a/libs/main/system/pisystemmodule.h +++ b/libs/main/system/pisystemmodule.h @@ -25,7 +25,7 @@ //! \~english \section cmake_module_System Building with CMake //! \~russian \section cmake_module_System Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP) //! \endcode diff --git a/libs/main/thread/pithread.h b/libs/main/thread/pithread.h index 9fffaadd..8aacc707 100644 --- a/libs/main/thread/pithread.h +++ b/libs/main/thread/pithread.h @@ -181,38 +181,47 @@ public: //! \{ //! \fn bool start(int timer_delay = -1) + //! \brief //! \~english Start thread //! \~russian Запускает поток //! \fn bool startOnce() + //! \brief //! \~english Start thread without internal loop //! \~russian Запускает поток без внутреннего цикла //! \fn bool startOnce(ThreadFunc func) + //! \brief //! \~english Start thread without internal loop //! \~russian Запускает поток без внутреннего цикла //! \fn void stop(bool wait = false) + //! \brief //! \~english Stop thread //! \~russian Останавливает поток //! \fn void terminate() + //! \brief //! \~english Strongly stop thread //! \~russian Жестко останавливает поток //! \fn bool waitForStart(int timeout_msecs = -1) + //! \brief //! \~english Wait for thread start //! \~russian Ожидает старта потока //! \fn bool waitForFinish(int timeout_msecs = -1) + //! \brief //! \~english Wait for thread finish //! \~russian Ожидает завершения потока //! \fn void lock() + //! \brief //! \~english Lock internal mutex //! \~russian Блокирует внутренний мьютекс //! \fn void unlock() + //! \brief //! \~english Unlock internal mutex //! \~russian Разблокирует внутренний мьютекс @@ -221,10 +230,12 @@ public: //! \{ //! \fn void started() + //! \brief //! \~english Raise on thread start //! \~russian Вызывается при старте потока //! \fn void stopped() + //! \brief //! \~english Raise on thread stop //! \~russian Вызывается при завершении потока diff --git a/libs/main/thread/pithreadmodule.h b/libs/main/thread/pithreadmodule.h index a3d0ac8c..f2031ba4 100644 --- a/libs/main/thread/pithreadmodule.h +++ b/libs/main/thread/pithreadmodule.h @@ -25,7 +25,7 @@ //! \~english \section cmake_module_Thread Building with CMake //! \~russian \section cmake_module_Thread Сборка с использованием CMake //! -//! \code +//! \~\code //! find_package(PIP REQUIRED) //! target_link_libraries([target] PIP) //! \endcode diff --git a/libs/main/thread/pitimer.h b/libs/main/thread/pitimer.h index 07983d2f..207cd686 100644 --- a/libs/main/thread/pitimer.h +++ b/libs/main/thread/pitimer.h @@ -221,10 +221,12 @@ public: //! \{ //! \fn void setInterval(double ms) + //! \brief //! \~english Set timer loop delay in milliseconds //! \~russian Установить интервал таймера "ms" миллисекунд //! \fn bool start() + //! \brief //! \~english Start timer with \a interval() loop delay //! \~russian Запустить таймер с интервалом \a interval() //! \~\details @@ -234,6 +236,7 @@ public: //! Запускает таймер с частотой = 1 / msecs Гц //! \fn bool start(double msecs) + //! \brief //! \~english Start timer with "msecs" loop delay //! \~russian Запустить таймер с интервалом "msecs" //! \~\details @@ -247,14 +250,17 @@ public: //! более 1 кГц //! \fn bool restart() + //! \brief //! \~english Stop and start timer with \a interval() loop delay //! \~russian Остановить и запустить таймер с интервалом \a interval() //! \fn bool stop(bool wait = true) + //! \brief //! \~english Stop timer and wait for it finish if "wait" //! \~russian Остановить таймер и если "wait" то дождаться остановки //! \fn void clearDelimiters() + //! \brief //! \~english Remove all frequency delimiters //! \~russian Удаляет все делители частоты @@ -263,6 +269,7 @@ public: //! \{ //! \fn void tickEvent(void * data, int delimiter) + //! \brief //! \~english Raise on timer tick //! \~russian Вызывается каждый тик таймера //! \~\details