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

This commit is contained in:
2026-10-02 16:45:50 +03:00
parent 6cbce6c360
commit 427fc70100
488 changed files with 2877 additions and 1 deletions

View File

@@ -1,3 +1,9 @@
/*
* Проверки abi: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include <stdio.h>
#include <stdlib.h>
#include <string.h>

View File

@@ -1,3 +1,9 @@
/*
* Проверки altera_logic: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include "altera_logic.h"
#include <assert.h>
#include <stdlib.h>

View File

@@ -1,3 +1,9 @@
/*
* Проверки altera_stream: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include "altera_stream.h"
#include <assert.h>
#include <stdlib.h>

View File

@@ -1,3 +1,9 @@
/*
* Проверки balsam_can: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include <stdio.h>
#include <string.h>

View File

@@ -1,3 +1,9 @@
/*
* Проверки boot: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include "set_boot.h"
#include <assert.h>
#include <string.h>

View File

@@ -1,3 +1,9 @@
/*
* Проверки emulator_services: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
/* Portable contract tests. Assertions stay enabled even in Release builds. */
#include "set_emu_server.h"
#include "set_crc.h"

View File

@@ -1,3 +1,9 @@
/*
* Проверки firmware_image: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include "firmware_image.h"
#include <assert.h>
#include <string.h>

View File

@@ -1,3 +1,19 @@
/*
* Проверки gui: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Сценарии для навигации по файлу:
* test_crc32
* test_ping_reference
* test_parser
* test_max_payload
* test_catalog_validate
* test_catalog_encode
* test_watch
* test_watch_timing
* Остальные сценарии продолжают эти проверки ниже в том же файле.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
/**
* Тесты GUI-протокола и каталога общего адресного пространства.
* Эталонные байты совпадают с SETGUI/tests/test_gas_catalog.py.

View File

@@ -1,3 +1,9 @@
/*
* Проверки modbus_server: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include <stdio.h>
#include <string.h>

View File

@@ -1,3 +1,9 @@
/*
* Проверки periph28335: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include <stdio.h>
#include <string.h>

View File

@@ -1,3 +1,9 @@
/*
* Проверки plot: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include "set_plot.h"
#include <assert.h>
#include <math.h>

View File

@@ -1,3 +1,17 @@
/*
* Проверки set_protocol: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Сценарии для навигации по файлу:
* test_crc_and_reference_frame
* test_parser
* test_status
* test_system_payloads
* test_can_binding
* test_firmware
* test_telemetry
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include "set_firmware.h"
#include "set_can.h"
#include "set_protocol.h"

View File

@@ -1,3 +1,9 @@
/*
* Проверки signal_wave: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include "set_signal.h"
#include "set_wavegen.h"
#include <assert.h>

View File

@@ -1,3 +1,9 @@
/*
* Проверки spectrum: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include "set_spectrum.h"
#include <assert.h>
#include <math.h>

View File

@@ -1,3 +1,11 @@
/*
* Проверки tms2812: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Сценарии для навигации по файлу:
* test_terminal
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include <stdio.h>
#include <string.h>

View File

@@ -1,3 +1,9 @@
/*
* Проверки tms2812_boot: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include <assert.h>
#include <stdio.h>
#include <string.h>

View File

@@ -1,3 +1,19 @@
/*
* Проверки transport: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Сценарии для навигации по файлу:
* test_crc
* test_encode
* test_encode_max
* test_roundtrip
* test_resync
* test_bad_crc
* test_id
* test_ring
* Остальные сценарии продолжают эти проверки ниже в том же файле.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
/**
* Тесты библиотеки. Платформенных зависимостей нет, собирается любым C99:
*

View File

@@ -1,3 +1,9 @@
/*
* Проверки trends: фиксируют ожидаемое поведение на воспроизводимых входных данных.
* Тестовые значения и подмены окружения относятся к проверке контракта; они не являются
* настройками рабочего устройства.
*/
#include <assert.h>
#include <stdio.h>
#include <string.h>