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

2026-10-02 16:45:50 +03:00
parent 6cbce6c360
commit 427fc70100
488 changed files with 2877 additions and 1 deletions
--- a/c/gas-logger/include/gas_logger.h
+++ b/c/gas-logger/include/gas_logger.h
@@ -1,3 +1,9 @@
+/*
+ * Непрерывная запись каналов в два банка и выдача согласованного снимка через регистровый
+ * интерфейс. Адреса и количества регистратора считаются в 16-битных словах, включая C28x;
+ * чтение снимка отделено от текущего сбора.
+ */
+
 /* Portable continuous recorder. All addresses/counts are 16-bit WORDS,
 * including on C28x (CHAR_BIT=16). No heap, UART, HAL or global state. */
 #ifndef GAS_LOGGER_H
--- a/c/gas-logger/include/gas_logger_pcan.h
+++ b/c/gas-logger/include/gas_logger_pcan.h
@@ -1,3 +1,9 @@
+/*
+ * Подключение регистратора к диспетчеру ProtoCAN GAS. Адаптер переводит относительное смещение
+ * региона в адрес регистратора и сопоставляет коды ошибок двух интерфейсов, сохраняя сам сбор
+ * данных в gas_logger.
+ */
+
 #ifndef GAS_LOGGER_PCAN_H
 #define GAS_LOGGER_PCAN_H
 #include "gas_logger.h"