SHS/pip
4
3
Fork 0
Code Issues 67 Pull Requests 1 Actions Releases Wiki Activity

doc groups

Browse Source
This commit is contained in:
Пелипенко Иван
2022-04-06 20:11:47 +03:00
parent c90d06871e
commit d5c27b1181
93 changed files with 1080 additions and 324 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
libs/main/thread/piblockingqueue.h
View File

@@ -1,3 +1,9 @@
/*! \file piblockingqueue.h
* \ingroup Thread
* \~\brief
* \~english Queue with blocking
* \~russian Блокирующая очередь
*/
/*
PIP - Platform Independent Primitives

6
libs/main/thread/piconditionvar.h
View File

@@ -1,3 +1,9 @@
/*! \file piconditionvar.h
* \ingroup Thread
* \~\brief
* \~english Conditional variable
* \~russian Conditional variable
*/
/*
PIP - Platform Independent Primitives

7
libs/main/thread/pigrabberbase.h
View File

@@ -1,6 +1,9 @@
/*! \file pigrabberbase.h
* \brief Abstract class for create grabbers
*/
* \ingroup Thread
* \~\brief
* \~english Abstract class for create grabbers
* \~russian Базовый класс для создания грабберов
*/
/*
PIP - Platform Independent Primitives
Abstract class for create grabbers

7
libs/main/thread/pimutex.h
View File

@@ -1,6 +1,9 @@
/*! \file pimutex.h
* \brief PIMutex, PIMutexLocker
*/
* \ingroup Thread
* \~\brief
* \~english Basic interthread lock
* \~russian Базовая межпоточная блокировка
*/
/*
PIP - Platform Independent Primitives
PIMutex, PIMutexLocker

7
libs/main/thread/pipipelinethread.h
View File

@@ -1,6 +1,9 @@
/*! \file pipipelinethread.h
* \brief Class for create multihread pipeline
*/
* \ingroup Thread
* \~\brief
* \~english Class for create multihread pipeline
* \~russian Класс для создания многопоточного конвейера
*/
/*
PIP - Platform Independent Primitives
Class for create multihread pipeline

7
libs/main/thread/pispinlock.h
View File

@@ -1,6 +1,9 @@
/*! \file pispinlock.h
* \brief PISpinlock
*/
* \ingroup Thread
* \~\brief
* \~english Fast and full-load lock
* \~russian Быстрая блокировка с полной нагрузкой
*/
/*
PIP - Platform Independent Primitives
PISpinlock

9
libs/main/thread/pithread.h
View File

@@ -1,8 +1,9 @@
/*! \file pithread.h
* \brief Thread
*
* This file declare thread class and some wait functions
*/
* \ingroup Thread
* \~\brief
* \~english Thread class
* \~russian Класс потока
*/
/*
PIP - Platform Independent Primitives
Thread

31
libs/main/thread/pithreadmodule.h
View File

@@ -16,6 +16,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 Thread
//! \~\brief
//! \~english Multithreading support.
//! \~russian Поддержка многопоточности.
//!
//! \~\details
//! \~english \section cmake_module Building with CMake
//! \~russian \section cmake_module Сборка с использованием CMake
//!
//! \code
//! find_package(PIP REQUIRED)
//! target_link_libraries([target] PIP)
//! \endcode
//!
//! \~english \par Common
//! \~russian \par Общее
//!
//! \~english
//! These files provides thread, timer, blocking and several complex multithreading techniques
//!
//! \~russian
//! Эти файлы обеспечивают потоки, таймера, блокировки и несколько сложных многопоточных техник
//!
//! \~\authors
//! \~english
//! Ivan Pelipenko peri4ko@yandex.ru;
//! Andrey Bychkov work.a.b@yandex.ru;
//! \~russian
//! Иван Пелипенко peri4ko@yandex.ru;
//! Андрей Бычков work.a.b@yandex.ru;
//!
#ifndef PITHREADMODULE_H
#define PITHREADMODULE_H

7
libs/main/thread/pithreadnotifier.h
View File

@@ -1,6 +1,9 @@
/*! \file pithreadnotifier.h
* \brief Class for simply notify and wait in different threads
*/
* \ingroup Thread
* \~\brief
* \~english Class for simple notify and wait in different threads
* \~russian Класс для простого уведомления и ожидания в различных потоках
*/
/*
PIP - Platform Independent Primitives
Class for simply notify and wait in different threads

9
libs/main/thread/pithreadpoolloop.h
View File

@@ -1,8 +1,9 @@
/*! \file pithreadpoolloop.h
* \brief Thread pool loop
*
* This file declare thread class and some wait functions
*/
* \ingroup Thread
* \~\brief
* \~english Thread pool loop
* \~russian Пул потоков
*/
/*
PIP - Platform Independent Primitives
Thread pool loop

7
libs/main/thread/pitimer.h
View File

@@ -1,6 +1,9 @@
/*! \file pitimer.h
* \brief Timer
*/
* \ingroup Thread
* \~\brief
* \~english Timer
* \~russian Таймер
*/
/*
PIP - Platform Independent Primitives
Timer