Обновление документации

K1llMan · Oct 5, 2024 · 51dbd23 · 51dbd23
1 parent 5d126d3
commit 51dbd23
Show file tree

Hide file tree

Showing 7 changed files with 39 additions and 5 deletions.
diff --git a/docs/source/api/branches/ynison.md b/docs/source/api/branches/ynison.md
@@ -0,0 +1,12 @@
+YYnisonAPI
+==================================================================
+
+------------------------------------------------------------------
+Методы
+------------------------------------------------------------------
+
+``` csharp
+public YnisonListener Connect(AuthStorage storage)
+```  
+
+Подключение к Унисон.
diff --git a/docs/source/api/root.rst b/docs/source/api/root.rst
@@ -34,6 +34,8 @@ YandexMusicAPI
    API для взаимодействия с пользовательскими данными.
 :doc:`User <branches/ugc>`
    API для взаимодействия с загружаемым пользователем содержимым.
+:doc:`User <branches/ynison>`
+   API для взаимодействия с Унисон.
 
 .. toctree::
    :hidden:
@@ -48,4 +50,5 @@ YandexMusicAPI
    branches/search
    branches/track
    branches/user
-   branches/ugc
+   branches/ugc
+   branches/ynison
diff --git a/docs/source/client/root.rst b/docs/source/client/root.rst
@@ -334,4 +334,10 @@ YandexMusicClient
 
    public List<YArtist> GetArtistsByLabel(YLabel label, int page = 0)
 
-Получение списка артистов лейбла.
+Получение списка артистов лейбла.
+
+.. code-block:: csharp
+
+   public void ConnectToYnison()
+
+Подключение к Унисон. Слушатель доступен через свойство клиента Ynison.
diff --git a/docs/source/common/auxiliary/auth-storage.rst b/docs/source/common/auxiliary/auth-storage.rst
@@ -2,7 +2,7 @@ AuthStorage
 ==================================================================
 
 Для взаимодействия с функциями API используется несколько вспомогательных классов,
-хранящих в себе информацию о пользователе, а также настройки выполнения.
+хранящих в себе информацию о пользователе, устройстве, а также настройки выполнения.
 
 ------------------------------------------------------------------
 Свойства
@@ -23,6 +23,11 @@ AuthStorage
 
    **Type**: bool   
 
+**DeviceId**
+   Идентификатор устройства.
+
+   **Type**: string
+
 **Token**
    Токен авторизации.
 
@@ -43,6 +48,12 @@ AuthStorage
 
 Конструктор.
 
+.. code-block:: csharp
+
+   public AuthStorage(IRequestProvider provider, DebugSettings settings = null)
+
+Конструктор.
+
 .. code-block:: csharp
 
    public void SetProxy(IWebProxy proxy)

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -36,7 +36,7 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Yandex Music API'
-copyright = '2023, K1llM@n'
+copyright = '2024, K1llM@n'
 author = 'K1llM@n, based on Winster332 project'
 
 language = 'ru'

diff --git a/docs/source/readme.md b/docs/source/readme.md
@@ -11,7 +11,7 @@ API переделано под работу с API официального п
 
 [Telegram-чат](https://t.me/yandex_music_api)
 
-Выражаю благодарность [участвовашим в разработке](https://github.com/K1llMan/Yandex.Music.Api/graphs/contributors).
+Выражаю благодарность [участвовавшим в разработке](https://github.com/K1llMan/Yandex.Music.Api/graphs/contributors).
 
 ```{include} ../../CHANGELOG.md
 ```

diff --git a/src/Yandex.Music.Api/README.md b/src/Yandex.Music.Api/README.md
@@ -130,6 +130,8 @@ YandexMusicApi
 │   ├── UploadUgcTrack / Async (AuthStorage storage, string uploadLink, string filePath)
 │   ├── UploadUgcTrack / Async (AuthStorage storage, string uploadLink, Stream stream)
 │   └── UploadUgcTrack / Async (AuthStorage storage, string uploadLink, byte[] file)
+├── Ynison
+│   └── Connect (AuthStorage storage)
 └── Future
     ...
 ```