From ee34e8a72edd13ca34dfd6e78c1c60b61069e4fc Mon Sep 17 00:00:00 2001 From: peri4 Date: Wed, 13 Nov 2024 16:32:21 +0300 Subject: [PATCH] doc --- doc/pages/summary.md | 80 +++++++++++++++++++++++++++----------------- 1 file changed, 50 insertions(+), 30 deletions(-) diff --git a/doc/pages/summary.md b/doc/pages/summary.md index 0a4adc5a..c7a0dce4 100644 --- a/doc/pages/summary.md +++ b/doc/pages/summary.md @@ -3,19 +3,19 @@ \~english -* direct output to console (\a PICout) -* containers (\a PIVector, \a PIDeque, \a PIVector2D, \a PIStack, \a PIQueue, \a PIMap, \a PISet) -* byte array (\a PIByteArray) -* serialization (\a PIBinaryStream, \a PITextStream, \a PIIOBinaryStream, \a PIIOTextStream, \a PIChunkStream, \a PIJSON) -* string (\a PIConstChars, \a PIString, \a PIStringList) -* base object (events and handlers) (\a PIObject) -* multithreading +* Direct output to console (\a PICout) +* Containers (\a PIVector, \a PIDeque, \a PIVector2D, \a PIStack, \a PIQueue, \a PIMap, \a PISet) +* Byte array (\a PIByteArray) +* Serialization (\a PIBinaryStream, \a PITextStream, \a PIIOBinaryStream, \a PIIOTextStream, \a PIChunkStream, \a PIJSON) +* String (\a PIConstChars, \a PIString, \a PIStringList) +* Base object (events and handlers) (\a PIObject) +* Multithreading * thread (\a PIThread) - * blocking (\a PIMutex, \a PISpinlock) - * executor (\a PIThreadPoolExecutor) + * blocking (\a PIMutex, \a PISpinlock, \a PIConditionVariable, \a PISemaphore, \a PIReadWriteLock) + * executor (\a PIThreadPoolExecutor, \a PIThreadPoolLoop) * blocking dequeue (\a PIBlockingDequeue) -* timer (\a PITimer) -* tiling console (with widgets) (\a PIScreen) + * timer (\a PITimer) +* Tiling console (with widgets) (\a PIScreen) * simple text rows * scroll bar * list @@ -37,7 +37,8 @@ * peering net node (\a PIPeer) * connection quality diagnotic (\a PIDiagnostics) * Run-time libraries - * abstract (\a PILibrary) + * external process (\a PIProcess) + * external library (\a PILibrary) * plugin (\a PIPluginLoader) * Mathematics * complex numbers @@ -49,24 +50,33 @@ * CRC checksum (\a PICRC) * Fourier transform (\a PIFFTW, \a PIFFT) * expression evaluator (\a PIEvaluator) -* command-line arguments parser (\a PICLI) -* process (\a PIProcess) +* Application-level + * command-line arguments parser (\a PICLI) + * system resources monitoring (\a PISystemMonitor) + * single-instance application control (\a PISingleApplication) + * high-level log (\a PILog) + * translation support (\a PITranslator) +* State machine ([By stantard](https://www.w3.org/TR/scxml/)) (\a PIStateMachine) +* High-level TCP client-server + * server (\a PIClientServer::Server, \a PIClientServer::ServerClient) + * client (\a PIClientServer::Client) +* Crypt support (\a PICrypt, \a PIAuth) \~russian -* общение с консолью (\a PICout) -* контейнеры (\a PIVector, \a PIDeque, \a PIVector2D, \a PIStack, \a PIQueue, \a PIMap, \a PISet) -* байтовый массив (\a PIByteArray) -* сериализация (\a PIBinaryStream, \a PITextStream, \a PIIOBinaryStream, \a PIIOTextStream, \a PIChunkStream) -* строка (\a PIConstChars, \a PIString, \a PIStringList) -* базовый объект (события и обработчики) (\a PIObject) -* многопоточность +* Общение с консолью (\a PICout) +* Контейнеры (\a PIVector, \a PIDeque, \a PIVector2D, \a PIStack, \a PIQueue, \a PIMap, \a PISet) +* Байтовый массив (\a PIByteArray) +* Сериализация (\a PIBinaryStream, \a PITextStream, \a PIIOBinaryStream, \a PIIOTextStream, \a PIChunkStream, \a PIJSON) +* Строка (\a PIConstChars, \a PIString, \a PIStringList) +* Базовый объект (события и обработчики) (\a PIObject) +* Многопоточность * поток (\a PIThread) - * блокировки (\a PIMutex, \a PISpinlock) - * исполнитель (\a PIThreadPoolExecutor) + * блокировки (\a PIMutex, \a PISpinlock, \a PIConditionVariable, \a PISemaphore, \a PIReadWriteLock) + * исполнитель (\a PIThreadPoolExecutor, \a PIThreadPoolLoop) * блокирующая очередь (\a PIBlockingDequeue) -* таймер (\a PITimer) -* тайлинговая консоль (с виджетами) (\a PIScreen) + * таймер (\a PITimer) +* Тайлинговая консоль (с виджетами) (\a PIScreen) * простой вывод строк * скроллбар * лист @@ -76,7 +86,7 @@ * прогрессбар * вывод PICout * текстовый ввод -* устройства ввода/вывода +* Устройства ввода/вывода * базовый класс (\a PIIODevice) * файл (\a PIFile) * последовательный порт (\a PISerial) @@ -87,8 +97,9 @@ * сложное составное устройство (\a PIConnection) * пиринговая сеть (\a PIPeer) * диагностика качества связи (\a PIDiagnostics) -* поддержка библиотек времени выполнения - * базовая функциональность (\a PILibrary) +* Поддержка библиотек времени выполнения + * внешний процесс (\a PIProcess) + * внешняя библиотека (\a PILibrary) * плагин (\a PIPluginLoader) * Математика * комплексные числа @@ -100,5 +111,14 @@ * CRC контрольная сумма (\a PICRC) * преобразования Фурье (\a PIFFTW, \a PIFFT) * вычислитель выражений (\a PIEvaluator) -* парсер аргументов командной строки (\a PICLI) -* процесс (\a PIProcess) +* Уровень приложения + * парсер аргументов командной строки (\a PICLI) + * мониторинг ресурсов системы (\a PISystemMonitor) + * контроль одного экземпляра приложения (\a PISingleApplication) + * высокоуровневый лог (\a PILog) + * поддержка перевода (\a PITranslator) +* Машина состояний ([По стандарту](https://www.w3.org/TR/scxml/)) (\a PIStateMachine) +* Высокоуровневый TCP клиент-сервер + * сервер (\a PIClientServer::Server, \a PIClientServer::ServerClient) + * клиент (\a PIClientServer::Client) +* Поддержка шифрования (\a PICrypt, \a PIAuth)