docs: добавь поясняющие комментарии к модулям и инструментам

2026-10-02 16:45:50 +03:00
parent 6cbce6c360
commit 427fc70100
488 changed files with 2877 additions and 1 deletions
--- a/doc/build-doxygen.ps1
+++ b/doc/build-doxygen.ps1
@@ -1,3 +1,7 @@
+# Генерация справочника API из Doxygen-комментариев исходников. Скрипт связывает конфигурацию
+# Doxyfile с каталогом результата; HTML является производным артефактом и не заменяет
+# комментарии в коде.
+
 [CmdletBinding()]
 param()

--- a/doc/build-html.bat
+++ b/doc/build-html.bat
@@ -1,4 +1,8 @@
@echo off
+rem Windows-точка запуска генератора HTML-документации. Передаёт управление скрипту сборки
+rem относительно своего каталога, чтобы запуск из другого рабочего каталога находил правильные
+rem исходники.
+
 setlocal EnableExtensions

 set "SCRIPT_DIR=%~dp0"
--- a/doc/build-setprotocol-html.ps1
+++ b/doc/build-setprotocol-html.ps1
@@ -1,3 +1,7 @@
+# Формирование HTML-справочника SETProtocol из исходной документации. Пути и шаблон определяют
+# состав выходной страницы; изменение справочника следует вносить в источник, используемый
+# этим генератором.
+
 [CmdletBinding()]
 param()

--- a/doc/setcan/build-html.bat
+++ b/doc/setcan/build-html.bat
@@ -1,4 +1,8 @@
@echo off
+rem Windows-точка запуска генератора HTML-документации. Передаёт управление скрипту сборки
+rem относительно своего каталога, чтобы запуск из другого рабочего каталога находил правильные
+rem исходники.
+
 setlocal

 set "SCRIPT_DIR=%~dp0"
--- a/doc/setcan/build-html.ps1
+++ b/doc/setcan/build-html.ps1
@@ -1,3 +1,7 @@
+# Сборка HTML-документации SETCAN из файлов исходного описания. Скрипт подготавливает
+# навигацию и содержимое страниц; выходные HTML-файлы предназначены для чтения вне среды
+# разработки.
+
 [CmdletBinding()]
 param()