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,7 @@
# Сборка библиотеки candle. Состав исходников и публичные include-пути задают подключение к
# проекту потребителя. Платформенные зависимости и условия сборки задаются здесь, а не в
# прикладных исходниках.
cmake_minimum_required(VERSION 3.15)
project(candle C)
if(NOT WIN32)

View File

@@ -19,6 +19,12 @@
*/
/*
* Доступ к CAN-адаптерам candleLight/gs_usb в Windows через WinUSB. Перечисление устройств,
* открытие канала и обмен кадрами образуют отдельный транспортный слой; он не интерпретирует
* прикладные регистры SETProtocol.
*/
#include "candle.h"
#include <stdarg.h>

View File

@@ -1,3 +1,7 @@
; Доступ к CAN-адаптерам candleLight/gs_usb в Windows через WinUSB. Перечисление устройств,
; открытие канала и обмен кадрами образуют отдельный транспортный слой; он не интерпретирует
; прикладные регистры SETProtocol.
EXPORTS
candle_list_scan
candle_list_free

View File

@@ -20,6 +20,12 @@
*/
/*
* Доступ к CAN-адаптерам candleLight/gs_usb в Windows через WinUSB. Перечисление устройств,
* открытие канала и обмен кадрами образуют отдельный транспортный слой; он не интерпретирует
* прикладные регистры SETProtocol.
*/
#pragma once
#include <stdint.h>
#include <stdbool.h>

View File

@@ -19,6 +19,11 @@
*/
/*
* Управляющие USB-запросы адаптера candleLight: конфигурация, временные параметры CAN и режим
* канала. Эти транзакции идут через control endpoint и отличаются от потока CAN-кадров.
*/
#include "candle_ctrl_req.h"
#include "ch_9.h"

View File

@@ -20,6 +20,11 @@
*/
/*
* Управляющие USB-запросы адаптера candleLight: конфигурация, временные параметры CAN и режим
* канала. Эти транзакции идут через control endpoint и отличаются от потока CAN-кадров.
*/
#pragma once
#include "candle_defs.h"

View File

@@ -20,6 +20,12 @@
*/
/*
* Двоичные структуры и константы gs_usb, общие для драйвера и USB-адаптера. Размеры полей и
* упаковка определяют совместимость с прошивкой: менять их как обычные внутренние структуры
* нельзя.
*/
#pragma once
#include <stdint.h>

View File

@@ -19,6 +19,11 @@
*/
/*
* Типы стандартных USB-дескрипторов и запросов из главы 9 спецификации USB. Драйвер использует
* их для описания устройства и конечных точек; это транспортные определения, а не формат CAN.
*/
#pragma once
#define USB_DIR_OUT 0 /* to device */