From f923915eb23de9261dd019af6fa14f6f1ddea473 Mon Sep 17 00:00:00 2001 From: Lisoveliy <1986developer@gmail.com> Date: Thu, 17 Oct 2024 18:07:42 +0300 Subject: [PATCH] docs: update docs for ServiceLogger --- docs/ru/interfaces/logger.md | 5 ++++- docs/ru/interfaces/service-logger.md | 12 ++++++++++++ 2 files changed, 16 insertions(+), 1 deletion(-) create mode 100644 docs/ru/interfaces/service-logger.md diff --git a/docs/ru/interfaces/logger.md b/docs/ru/interfaces/logger.md index e1a983e..9afabb1 100644 --- a/docs/ru/interfaces/logger.md +++ b/docs/ru/interfaces/logger.md @@ -2,7 +2,10 @@ ## Введение -Логирование неотъемлимая часть в создании и отладке программ, соответственно проект SVET старается сделать этот процесс наиболее дружелюбным для программистов. Класс Logger представляет из себя интерфейс взаимодействия с конечным пользователем посредством **Serial** порта используя переферийное ядро как показано на диаграмме. +Логирование неотъемлимая часть в создании и отладке программ, соответственно проект SVET старается сделать этот процесс наиболее дружелюбным для программистов. Класс Logger представляет из себя интерфейс взаимодействия с конечным пользователем посредством **Serial** порта используя переферийное ядро как показано на диаграмме. + +>[!IMPORTANT] +>Для использования логгера рекомендуется не обращаться к классу Logger напрямую. Для логирования в своих проектах используйте адаптер [ServiceLogger](service-logger.md) <p align="center"> <img src="https://github.com/Lisoveliy/SVET/blob/master/docs/LoggerIOArch.drawio.svg?raw=true" alt="Logger IO Arch"/> diff --git a/docs/ru/interfaces/service-logger.md b/docs/ru/interfaces/service-logger.md new file mode 100644 index 0000000..77fa750 --- /dev/null +++ b/docs/ru/interfaces/service-logger.md @@ -0,0 +1,12 @@ +# ServiceLogger + + +## Введение +>[!IMPORTANT] +>Этот класс - обёртка над [Logger](logger.md). Для понимания работы и подключения логгирования в проект прочитайте [Создание Logger](logger.md#создание-logger). + +<p align="center"> +<img src="https://github.com/Lisoveliy/SVET/blob/master/docs/LoggerIOArch.drawio.svg?raw=true" alt="Logger IO Arch"/> +</p> + +# WIP \ No newline at end of file