Repair docs (html, md). Update docstrings

This commit is contained in:
parent e264750187
commit 6a4ad48577
125 changed files with 3706 additions and 4913 deletions

View file

@ -3,19 +3,19 @@ from typing import Optional, List
class WifiAccessPoint(BaseModel):
"""
Модель точки доступа Wi-Fi
"""Модель Wi-Fi точки доступа.
Атрибуты:
ssid (Optional[str]): Название точки доступа. Может быть скрытым
bssid (str): Уникальный идентификатор точки доступа (по типу MAC-адреса)
channel (Optional[int]): Канал, на котором работает точка доступа
signal (Optional[int]): Уровень сигнала (dBm)
encryption (Optional[str]): Тип шифрования (WPA2, WPA3, открытая и т.д.)
frequency (Optional[str]): Частота вещания (2.4GHz/5GHz)
vendor (Optional[str]): Производитель точки доступа (определяется по MAC-адресу)
hidden (bool): Флаг скрытия названия точки доступа (ssid)
note (Optional[str]): Заметка для точки доступа
- ``ssid`` (Optional[str]): Название сети (может быть скрытым).
- ``bssid`` (str): Уникальный идентификатор точки доступа.
- ``channel`` (Optional[int]): Номер канала.
- ``signal`` (Optional[int]): Уровень сигнала в dBm.
- ``encryption`` (Optional[str]): Тип шифрования (WPA/WPA2/WPA3/открытая).
- ``frequency`` (Optional[str]): Диапазон частот (2.4/5 ГГц).
- ``vendor`` (Optional[str]): Производитель оборудования.
- ``hidden`` (bool): Флаг скрытого SSID.
- ``note`` (Optional[str]): Пользовательская заметка.
"""
ssid: Optional[str] = None
@ -30,11 +30,11 @@ class WifiAccessPoint(BaseModel):
class WifiScanResult(BaseModel):
"""
Результат сканирования Wi-Fi
"""Результат сканирования Wi-Fi.
Атрибуты:
access_points (List[WifiAccessPoint]): Список найденных Wi-Fi точек доступа
- ``access_points`` (List[WifiAccessPoint]): Найденные точки доступа.
"""
access_points: List[WifiAccessPoint]
access_points: List[WifiAccessPoint]