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

This commit is contained in:
2026-10-02 16:46:19 +03:00
parent 6cbce6c360
commit 427fc70100
488 changed files with 2877 additions and 1 deletions
+4
View File
@@ -1,3 +1,7 @@
# Сборка библиотеки set_modbus. Состав исходников и публичные include-пути задают подключение
# к проекту потребителя. Файл также собирает и регистрирует хостовые проверки; запускать их
# следует через CTest из каталога сборки.
cmake_minimum_required(VERSION 3.13)
project(set_modbus C)
add_library(set_modbus STATIC src/modbus_data.c)
+6
View File
@@ -1,3 +1,9 @@
/*
* Проверка количества данных и перенос значений Modbus между сообщением и банком регистров.
* Coils упакованы младшим битом вперёд, а пары байтов сообщения имеют собственный порядок;
* адресный диапазон проверяет вызывающий порт.
*/
#ifndef SET_MODBUS_DATA_H
#define SET_MODBUS_DATA_H
#include <stddef.h>
+6
View File
@@ -1,3 +1,9 @@
/*
* Исторический STM32-порт Modbus с привязкой к окружению прошивки. Здесь находятся транспорт и
* обслуживание запросов конкретной платформы; переносимые операции над данными вынесены в
* modbus_data.
*/
/**
**************************************************************************
* @file modbus.c
+6
View File
@@ -1,3 +1,9 @@
/*
* Проверка количества данных и перенос значений Modbus между сообщением и банком регистров.
* Coils упакованы младшим битом вперёд, а пары байтов сообщения имеют собственный порядок;
* адресный диапазон проверяет вызывающий порт.
*/
#include "../include/modbus_data.h"
uint8_t mb_data_validate(uint8_t function, uint16_t quantity, uint16_t bytes, size_t capacity)
+6
View File
@@ -1,3 +1,9 @@
/*
* Проверки modbus_data: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include "modbus_data.h"
#include <assert.h>
#include <string.h>