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 @@
# Входная точка пакета altera_logic. Определяет доступные при импорте имена; подробные
# контракты находятся в специализированных модулях пакета. Изменение реэкспортов влияет на
# существующие import у потребителей.
"""Portable Altera analyzer client. Wire protocol and sequencing live in C99."""
from .native import Capture, NativeAnalyzer

View File

@@ -1,3 +1,7 @@
# Состояние измерительных маркеров и линеек графика. Маркер относится к координатам
# отображаемого сигнала; его перемещение не изменяет полученные выборки или настройки
# транспорта.
"""Presentation state for waveform rulers; no transport or wire processing."""
from dataclasses import dataclass

View File

@@ -1,3 +1,8 @@
# Автомат UART-клиента логического анализатора Altera: запрос, накопление ответа и контроль
# времени. Одновременно выполняется одна операция; ARM нельзя безусловно повторять, поскольку
# повторный запуск меняет состояние захвата. Здесь только ctypes-привязка: протокольного
# fallback на Python нет.
"""ctypes binding only: no Python packet codec or protocol fallback."""
from __future__ import annotations

View File

@@ -1,3 +1,6 @@
# Qt-прокрутка области графика анализатора: колесо перемещает X, Ctrl с колесом — Y.
# Обработчик меняет область просмотра, сохраняя масштаб и исходный массив захвата.
"""Qt presentation port: wheel pans X; Ctrl+wheel pans Y, never zooms."""
from PySide6.QtCore import Qt, Signal
from PySide6.QtWidgets import QScrollArea

View File

@@ -1,3 +1,6 @@
# Последовательный Qt-порт анализатора Altera. Порт обслуживает соединение, таймеры и события,
# а решения о запросах, ответах и таймаутах принимает автомат C99.
"""Qt serial/lifecycle port. Protocol decisions are exclusively in C99."""
from __future__ import annotations

View File

@@ -1,3 +1,7 @@
# Клиентский приём потока SETCAN логического анализатора. CAN-события или UART-оболочка
# передаются общему приёмнику; накопление выборок и частота перерисовки разделены, чтобы поток
# пакетов не перегружал GUI.
"""SETCAN streaming FFI and immutable display/export models. No wire codec."""
from __future__ import annotations
import csv

View File

@@ -1,3 +1,7 @@
# Клиентский приём потока SETCAN логического анализатора. CAN-события или UART-оболочка
# передаются общему приёмнику; накопление выборок и частота перерисовки разделены, чтобы поток
# пакетов не перегружал GUI.
"""Qt transport/lifecycle port for the C SETCAN stream receiver.
CAN ingress accepts canonical RX events from an existing bus connection.