Lisoveliy/SVET
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update docs for ServiceLogger

Browse Source
This commit is contained in:
Pavel-Savely Savianok 2024-10-17 18:07:42 +03:00
parent d7b05430bd
commit f923915eb2
2 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
docs/ru/interfaces/logger.md
View File

@ -2,7 +2,10 @@
## Введение ## Введение
Логирование неотъемлимая часть в создании и отладке программ, соответственно проект SVET старается сделать этот процесс наиболее дружелюбным для программистов. Класс Logger представляет из себя интерфейс взаимодействия с конечным пользователем посредством **Serial** порта используя переферийное ядро как показано на диаграмме. Логирование неотъемлимая часть в создании и отладке программ, соответственно проект SVET старается сделать этот процесс наиболее дружелюбным для программистов. Класс Logger представляет из себя интерфейс взаимодействия с конечным пользователем посредством **Serial** порта используя переферийное ядро как показано на диаграмме.
>[!IMPORTANT]
>Для использования логгера рекомендуется не обращаться к классу Logger напрямую. Для логирования в своих проектах используйте адаптер [ServiceLogger](service-logger.md)
<p align="center"> <p align="center">
<img src="https://github.com/Lisoveliy/SVET/blob/master/docs/LoggerIOArch.drawio.svg?raw=true" alt="Logger IO Arch"/> <img src="https://github.com/Lisoveliy/SVET/blob/master/docs/LoggerIOArch.drawio.svg?raw=true" alt="Logger IO Arch"/>

12
docs/ru/interfaces/service-logger.md Normal file
View File

@ -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