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

7
libs/main/io_utils/pibasetransfer.h
View File

@@ -1,6 +1,9 @@
/*! \file pibasetransfer.h
* \brief Base class for reliable send and receive data in fixed packets with error correction, pause and resume
*/
* \ingroup IO
* \~\brief
* \~english Base class for reliable send and receive data in fixed packets with error correction, pause and resume
* \~russian Базовый класс для надежного обмена данными с помощью фиксированных пакетов с коррекцией ошибок и паузой
*/
/*
PIP - Platform Independent Primitives
Base class for reliable send and receive data in fixed packets with error correction, pause and resume

7
libs/main/io_utils/pibroadcast.h
View File

@@ -1,6 +1,9 @@
/*! \file pibroadcast.h
* \brief Broadcast for all interfaces, including loopback
*/
* \ingroup IO-Utils
* \~\brief
* \~english Broadcast for all interfaces, including loopback
* \~russian Широкое вещание на все интерфейсы, включая loopback
*/
/*
PIP - Platform Independent Primitives
Broadcast for all interfaces, including loopback

8
libs/main/io_utils/piconnection.h
View File

@@ -1,6 +1,10 @@
/*! \file piconnection.h
* \brief Complex I/O point
*/
* \brief
* \ingroup IO-Utils
* \~\brief
* \~english Complex I/O point
* \~russian Составное устройство ввода/вывода
*/
/*
PIP - Platform Independent Primitives
Complex I/O point

7
libs/main/io_utils/pidatatransfer.h
View File

@@ -1,6 +1,9 @@
/*! \file pidatatransfer.h
* \brief Class for send and receive PIByteArray via \a PIBaseTransfer
*/
* \ingroup IO
* \~\brief
* \~english Class for send and receive PIByteArray via \a PIBaseTransfer
* \~russian Класс для отправки и приема PIByteArray с помощью \a PIBaseTransfer
*/
/*
PIP - Platform Independent Primitives
Class for send and receive PIByteArray via PIBaseTransfer

7
libs/main/io_utils/pidiagnostics.h
View File

@@ -1,6 +1,9 @@
/*! \file pidiagnostics.h
* \brief Connection quality diagnostics
*/
* \ingroup IO
* \~\brief
* \~english Connection quality diagnostics
* \~russian Диагностика качества связи
*/
/*
PIP - Platform Independent Primitives
Speed and quality in/out diagnostics

7
libs/main/io_utils/piethutilbase.h
View File

@@ -1,6 +1,9 @@
/*! \file piethutilbase.h
* \brief Base class for ethernet utils
*/
* \ingroup IO-Utils
* \~\brief
* \~english Base class for ethernet utils
* \~russian Базовый класс для утилит ethernet
*/
/*
PIP - Platform Independent Primitives
Base class for ethernet utils

7
libs/main/io_utils/pifiletransfer.h
View File

@@ -1,6 +1,9 @@
/*! \file pifiletransfer.h
* \brief Class for send and receive files and directories via \a PIBaseTransfer
*/
* \ingroup IO
* \~\brief
* \~english Class for send and receive files and directories via \a PIBaseTransfer
* \~russian Класс для отправки и приема файлов и папок с помощью \a PIBaseTransfer
*/
/*
PIP - Platform Independent Primitives
Class for send and receive files and directories via PIBaseTransfer

32
libs/main/io_utils/piioutilsmodule.h
View File

@@ -16,10 +16,42 @@
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 IO-Utils
//! \~\brief
//! \~english Complex channel transport
//! \~russian Сложный канальный транспорт
//!
//! \~\details
//! \~english \section cmake_module Building with CMake
//! \~russian \section cmake_module Сборка с использованием CMake
//!
//! \code
//! find_package(PIP REQUIRED)
//! target_link_libraries([target] PIP::IOUtils)
//! \endcode
//!
//! \~english \par Common
//! \~russian \par Общее
//!
//! \~english
//! These files provides complex transport over ethernet
//!
//! \~russian
//! Эти файлы обеспечивают сложный транспорт поверх ethernet
//!
//! \~\authors
//! \~english
//! Ivan Pelipenko peri4ko@yandex.ru;
//! Andrey Bychkov work.a.b@yandex.ru;
//! \~russian
//! Иван Пелипенко peri4ko@yandex.ru;
//! Андрей Бычков work.a.b@yandex.ru;
//!
#ifndef PIIOUTILSMODULE_H
#define PIIOUTILSMODULE_H
#include "pibasetransfer.h"
#include "piconnection.h"
#include "pidatatransfer.h"

7
libs/main/io_utils/pipacketextractor.h
View File

@@ -1,6 +1,9 @@
/*! \file pipacketextractor.h
* \brief Packets extractor
*/
* \ingroup IO
* \~\brief
* \~english Packets extractor
* \~russian Извлекатель пакетов
*/
/*
PIP - Platform Independent Primitives
Packets extractor

7
libs/main/io_utils/piparsehelper.h
View File

@@ -1,6 +1,9 @@
/*! \file piparsehelper.h
* \brief Helper class to automate structs receive
*/
* \ingroup IO
* \~\brief
* \~english Helper class to automate structs receive
* \~russian Класс для автоматизации приема структур
*/
/*
PIP - Platform Independent Primitives
Helper class to automate structs receive

7
libs/main/io_utils/pistreampacker.h
View File

@@ -1,6 +1,9 @@
/*! \file pistreampacker.h
* \brief Simple packet wrap aroud any PIIODevice
*/
* \ingroup IO-Utils
* \~\brief
* \~english Simple packet wrap aroud any PIIODevice
* \~russian Простая фрагментация пакетов, использует любой PIIODevice
*/
/*
PIP - Platform Independent Primitives
Simple packet wrap aroud any PIIODevice