doc groups

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

View File

@@ -1,6 +1,9 @@
/*! \file pilibrary.h
* \brief Dynamic library
*/
* \ingroup System
* \~\brief
* \~english Run-time library
* \~russian Run-time библиотека
*/
/*
PIP - Platform Independent Primitives
Dynamic library

View File

@@ -1,6 +1,9 @@
/*! \file piplugin.h
* \brief Plugin helpers
*/
* \ingroup System
* \~\brief
* \~english Plugin control
* \~russian Управление плагинами
*/
/*
PIP - Platform Independent Primitives
Plugin helpers

View File

@@ -1,6 +1,9 @@
/*! \file piprocess.h
* \brief Process
*/
* \ingroup System
* \~\brief
* \~english External process
* \~russian Внешний процесс
*/
/*
PIP - Platform Independent Primitives
Process

View File

@@ -1,6 +1,9 @@
/*! \file pisignals.h
* \brief System signals
*/
* \ingroup System
* \~\brief
* \~english System signals
* \~russian Сигналы системы
*/
/*
PIP - Platform Independent Primitives
Signals

View File

@@ -1,3 +1,9 @@
/*! \file pisysteminfo.h
* \ingroup System
* \~\brief
* \~english System information
* \~russian Информация о системе
*/
/*
PIP - Platform Independent Primitives
System information

View File

@@ -16,6 +16,39 @@
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 System
//! \~\brief
//! \~english System information and external executables and libraries 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 system information, resource monitoring, run-time libraries and
//! control of external executables.
//!
//! \~russian
//! Эти файлы обеспечивают информацию о системе, мониторинг ресурсов, run-time библиотеки
//! и управление внешними исполняемыми файлами.
//!
//! \~\authors
//! \~english
//! Ivan Pelipenko peri4ko@yandex.ru;
//! Andrey Bychkov work.a.b@yandex.ru;
//! \~russian
//! Иван Пелипенко peri4ko@yandex.ru;
//! Андрей Бычков work.a.b@yandex.ru;
//!
#ifndef PISYSTEMMODULE_H
#define PISYSTEMMODULE_H

View File

@@ -1,3 +1,9 @@
/*! \file pisystemmonitor.h
* \ingroup System
* \~\brief
* \~english System resources monitoring
* \~russian Мониторинг ресурсов системы
*/
/*
PIP - Platform Independent Primitives
Process resource monitor