From 9be68c86790ac3d095cc4679b1add714c45246d6 Mon Sep 17 00:00:00 2001 From: CaCTuCaTu4ECKuu Date: Fri, 2 Mar 2018 17:19:12 +0300 Subject: [PATCH] Refactoring Fix some methods and properties description Left TODO marks on unkommented methods and classes --- .../Async/IDatabaseCategoryAsync.cs | 8 +- .../Async/IMessagesCategoryAsync.cs | 5 +- VkNet/Abstractions/IDatabaseCategory.cs | 8 +- VkNet/Abstractions/IVkApiInvoke.cs | 3 + VkNet/Categories/MarketsCategory.cs | 29 ++--- VkNet/Categories/VideoCategory.cs | 109 +++++++++--------- .../Wall/EditAdsStealthParams.cs | 3 + .../JsonConverter/SafetyEnumJsonConverter.cs | 14 ++- 8 files changed, 96 insertions(+), 83 deletions(-) diff --git a/VkNet/Abstractions/Async/IDatabaseCategoryAsync.cs b/VkNet/Abstractions/Async/IDatabaseCategoryAsync.cs index 38bfad7c7..9177fca86 100644 --- a/VkNet/Abstractions/Async/IDatabaseCategoryAsync.cs +++ b/VkNet/Abstractions/Async/IDatabaseCategoryAsync.cs @@ -66,17 +66,17 @@ public interface IDatabaseCategoryAsync /// /// Возвращает список городов. /// - /// Параметры запроса database.getCities + /// Параметры запроса database.getCities /// Cписок городов /// /// Возвращает коллекцию городов, каждый из которых содержит поля City.Id /// При наличии информации о регионе и/или области, в которых находится данный город, в объекте могут дополнительно /// включаться поля City.Area - /// Если не задан параметр , то будет возвращен список самых крупных городов в заданной стране. - /// Если задан параметр , то будет возвращен список городов, которые релевантны поисковому запросу. + /// Если не задан параметр , то будет возвращен список самых крупных городов в заданной стране. + /// Если задан параметр , то будет возвращен список городов, которые релевантны поисковому запросу. /// Страница документации ВКонтакте http://vk.com/dev/database.getCities /// - Task> GetCitiesAsync(GetCitiesParams @params); + Task> GetCitiesAsync(GetCitiesParams parameters); /// /// Возвращает информацию о городах по их идентификаторам. diff --git a/VkNet/Abstractions/Async/IMessagesCategoryAsync.cs b/VkNet/Abstractions/Async/IMessagesCategoryAsync.cs index 3915c1550..7e61b8f44 100644 --- a/VkNet/Abstractions/Async/IMessagesCategoryAsync.cs +++ b/VkNet/Abstractions/Async/IMessagesCategoryAsync.cs @@ -427,20 +427,19 @@ Task> GetChatAsync(IEnumerable chatIds, ProfileFi /// /// Отправляет стикер. /// - /// Параметры запроса. + /// Параметры запроса. /// /// После успешного выполнения возвращает идентификатор отправленного сообщения (mid). /// /// /// Страница документации ВКонтакте http://vk.com/dev/messages.sendSticker /// - Task SendStickerAsync(MessagesSendStickerParams @params); + Task SendStickerAsync(MessagesSendStickerParams parameters); /// /// Возвращает материалы диалога или беседы.. /// /// Параметры запроса. - /// Новое значение start_from. /// /// После успешного выполнения возвращает массив объектов photo, video, audio или doc, в зависимости от значения media_type, а также дополнительное поле next_from, содержащее новое значение start_from. /// Если в media_type передано значение link, возвращает список объектов-ссылок: diff --git a/VkNet/Abstractions/IDatabaseCategory.cs b/VkNet/Abstractions/IDatabaseCategory.cs index b4ebac009..500ec1392 100644 --- a/VkNet/Abstractions/IDatabaseCategory.cs +++ b/VkNet/Abstractions/IDatabaseCategory.cs @@ -65,17 +65,17 @@ public interface IDatabaseCategory : IDatabaseCategoryAsync /// /// Возвращает список городов. /// - /// Параметры запроса database.getCities + /// Параметры запроса database.getCities /// Cписок городов /// /// Возвращает коллекцию городов, каждый из которых содержит поля City.Id /// При наличии информации о регионе и/или области, в которых находится данный город, в объекте могут дополнительно /// включаться поля City.Area - /// Если не задан параметр , то будет возвращен список самых крупных городов в заданной стране. - /// Если задан параметр , то будет возвращен список городов, которые релевантны поисковому запросу. + /// Если не задан параметр , то будет возвращен список самых крупных городов в заданной стране. + /// Если задан параметр , то будет возвращен список городов, которые релевантны поисковому запросу. /// Страница документации ВКонтакте http://vk.com/dev/database.getCities /// - VkCollection GetCities(GetCitiesParams @params); + VkCollection GetCities(GetCitiesParams parameters); /// /// Возвращает информацию о городах по их идентификаторам. diff --git a/VkNet/Abstractions/IVkApiInvoke.cs b/VkNet/Abstractions/IVkApiInvoke.cs index 41c865df2..4284a7a3f 100644 --- a/VkNet/Abstractions/IVkApiInvoke.cs +++ b/VkNet/Abstractions/IVkApiInvoke.cs @@ -6,6 +6,9 @@ namespace VkNet.Abstractions { + /// + /// TODO: Description + /// public interface IVkApiInvoke { /// diff --git a/VkNet/Categories/MarketsCategory.cs b/VkNet/Categories/MarketsCategory.cs index 1adbcea67..056dd9898 100644 --- a/VkNet/Categories/MarketsCategory.cs +++ b/VkNet/Categories/MarketsCategory.cs @@ -426,20 +426,21 @@ public long AddAlbum(long ownerId, string title, long? photoId = null, bool main return _vk.Call("market.addAlbum", parameters)["market_album_id"]; } - /// - /// Редактирует подборку с товарами. - /// - /// Идентификатор владельца подборки. Обратите внимание, идентификатор сообщества в параметре owner_id необходимо указывать со знаком "-" — например, owner_id=-1 соответствует идентификатору сообщества ВКонтакте API (club1) целое число, обязательный параметр (целое число, обязательный параметр). - /// Идентификатор подборки. положительное число, обязательный параметр (положительное число, обязательный параметр). - /// Название подборки. строка, обязательный параметр, максимальная длина 128 (строка, обязательный параметр, максимальная длина 128). - /// Идентификатор фотографии-обложки подборки. положительное число (положительное число). - /// - /// После успешного выполнения возвращает 1. - /// - /// - /// Страница документации ВКонтакте http://vk.com/dev/market.editAlbum - /// - public bool EditAlbum(long ownerId, long albumId, string title, long? photoId = null, bool mainAlbum = false) + /// + /// Редактирует подборку с товарами. + /// + /// Идентификатор владельца подборки. Обратите внимание, идентификатор сообщества в параметре owner_id необходимо указывать со знаком "-" — например, owner_id=-1 соответствует идентификатору сообщества ВКонтакте API (club1) целое число, обязательный параметр (целое число, обязательный параметр). + /// Идентификатор подборки. положительное число, обязательный параметр (положительное число, обязательный параметр). + /// Название подборки. строка, обязательный параметр, максимальная длина 128 (строка, обязательный параметр, максимальная длина 128). + /// Идентификатор фотографии-обложки подборки. положительное число (положительное число). + /// Назначить подборку основной. + /// + /// После успешного выполнения возвращает 1. + /// + /// + /// Страница документации ВКонтакте http://vk.com/dev/market.editAlbum + /// + public bool EditAlbum(long ownerId, long albumId, string title, long? photoId = null, bool mainAlbum = false) { var parameters = new VkParameters { { "owner_id", ownerId }, diff --git a/VkNet/Categories/VideoCategory.cs b/VkNet/Categories/VideoCategory.cs index daa20d15f..c5926841a 100644 --- a/VkNet/Categories/VideoCategory.cs +++ b/VkNet/Categories/VideoCategory.cs @@ -659,62 +659,59 @@ public VkCollection GetAlbumsByVideo(long? targetId, long ownerId, l return _vk.Call("video.getAlbumsByVideo", parameters).ToVkCollectionOf(x => x); } - /// - /// Позволяет получить представление каталога видео. - /// - /// Число блоков каталога, информацию о которых необходимо вернуть. положительное число, по умолчанию 10, максимальное значение 16 (Положительное число, по умолчанию 10, максимальное значение 16). - /// Число видеозаписей в каждом блоке. положительное число, по умолчанию 10, максимальное значение 16 (Положительное число, по умолчанию 10, максимальное значение 16). - /// Параметр для получения следующей страницы результатов. Значение, необходимое для передачи в этом параметре, возвращается в поле ответа next. строка (Строка). - /// 1 — возвращать дополнительную информацию о пользователях и сообществах в полях profiles и groups. флаг, может принимать значения 1 или 0, по умолчанию 0 (Флаг, может принимать значения 1 или 0, по умолчанию 0). - /// - /// После успешного выполнения возвращает массив объектов — блоков видеокаталога. Каждый из объектов содержит массив объектов — элементов блока и дополнительную информацию для отображения блока. - /// Данные для отображения блока видеокаталога - /// name заголовок блока. - /// строка id идентификатор блока. Возвращается строка для предопределенных блоков. Для других возвращается число. - /// Предопределенные блоки: - /// my — видеозаписи пользователя; - /// feed — записи сообществ и друзей, содержащие видеозаписи, а также новые видеозаписи, добавленные ими; - /// ugc — популярные видеозаписи; - /// series — сериалы и телешоу. - /// строка или число can_hide наличие возможности скрыть блок. - /// флаг, может принимать значения 1 или 0 type тип блока. Может принимать значения: - /// channel — видеозаписи сообщества; - /// category — подборки видеозаписей. - /// строка next параметр для получения следующей страницы результатов. Необходимо передать его значение в from в следующем вызове, чтобы получить содержимое каталога, следующее за полученным в текущем вызове. - /// строка - /// Элемент блока видеокаталога - /// id идентификатор элемента. - /// положительное число owner_id идентификатор владельца элемента. - /// int (числовое значение) title заголовок. - /// строка type тип элемента. Может принимать значения: - /// video — видеоролик; - /// album — альбом. - /// - /// строка - /// type=video. Дополнительные поля для элемента-видеоролика - /// duration длительность в секундах. - /// положительное число description описание. - /// строка date дата добавления. - /// положительное число views число просмотров. - /// положительное число comments число комментариев. - /// положительное число photo_130 URL изображения-обложки видео с размером 130x98px. - /// строка photo_320 URL изображения-обложки видео с размером 320x240px. - /// строка photo_640 URL изображения-обложки видео с размером 640x480px (если размер есть). - /// строка can_add наличие возможности добавить видео в свой список. - /// флаг, может принимать значения 1 или 0 can_edit наличие возможности редактировать видео. - /// флаг, может принимать значения 1 или 0 - /// type=album. Дополнительные поля для элемента-альбома - /// count число видеозаписей в альбоме. - /// положительное число photo_320 URL изображения-обложки альбома с размером 544x300px. - /// строка photo_160 URL изображения-обложки альбома с размером 272x150px. - /// строка updated_time время последнего обновления альбома. - /// положительное число - /// Если был передан параметр extended=1, возвращаются дополнительные объекты profiles и groups, содержащие информацию о пользователях и сообществах. - /// - /// - /// Страница документации ВКонтакте http://vk.com/dev/video.getCatalog - /// - public ReadOnlyCollection GetCatalog(VideoGetCatalogParams @params) + /// + /// Позволяет получить представление каталога видео. + /// + /// Позволяет получить представление каталога видео. + /// + /// После успешного выполнения возвращает массив объектов — блоков видеокаталога. Каждый из объектов содержит массив объектов — элементов блока и дополнительную информацию для отображения блока. + /// Данные для отображения блока видеокаталога + /// name заголовок блока. + /// строка id идентификатор блока. Возвращается строка для предопределенных блоков. Для других возвращается число. + /// Предопределенные блоки: + /// my — видеозаписи пользователя; + /// feed — записи сообществ и друзей, содержащие видеозаписи, а также новые видеозаписи, добавленные ими; + /// ugc — популярные видеозаписи; + /// series — сериалы и телешоу. + /// строка или число can_hide наличие возможности скрыть блок. + /// флаг, может принимать значения 1 или 0 type тип блока. Может принимать значения: + /// channel — видеозаписи сообщества; + /// category — подборки видеозаписей. + /// строка next параметр для получения следующей страницы результатов. Необходимо передать его значение в from в следующем вызове, чтобы получить содержимое каталога, следующее за полученным в текущем вызове. + /// строка + /// Элемент блока видеокаталога + /// id идентификатор элемента. + /// положительное число owner_id идентификатор владельца элемента. + /// int (числовое значение) title заголовок. + /// строка type тип элемента. Может принимать значения: + /// video — видеоролик; + /// album — альбом. + /// + /// строка + /// type=video. Дополнительные поля для элемента-видеоролика + /// duration длительность в секундах. + /// положительное число description описание. + /// строка date дата добавления. + /// положительное число views число просмотров. + /// положительное число comments число комментариев. + /// положительное число photo_130 URL изображения-обложки видео с размером 130x98px. + /// строка photo_320 URL изображения-обложки видео с размером 320x240px. + /// строка photo_640 URL изображения-обложки видео с размером 640x480px (если размер есть). + /// строка can_add наличие возможности добавить видео в свой список. + /// флаг, может принимать значения 1 или 0 can_edit наличие возможности редактировать видео. + /// флаг, может принимать значения 1 или 0 + /// type=album. Дополнительные поля для элемента-альбома + /// count число видеозаписей в альбоме. + /// положительное число photo_320 URL изображения-обложки альбома с размером 544x300px. + /// строка photo_160 URL изображения-обложки альбома с размером 272x150px. + /// строка updated_time время последнего обновления альбома. + /// положительное число + /// Если был передан параметр extended=1, возвращаются дополнительные объекты profiles и groups, содержащие информацию о пользователях и сообществах. + /// + /// + /// Страница документации ВКонтакте http://vk.com/dev/video.getCatalog + /// + public ReadOnlyCollection GetCatalog(VideoGetCatalogParams @params) { var parameters = new VkParameters { { "count", @params.Count }, diff --git a/VkNet/Model/RequestParams/Wall/EditAdsStealthParams.cs b/VkNet/Model/RequestParams/Wall/EditAdsStealthParams.cs index ccd2b43a3..dbe01daf1 100644 --- a/VkNet/Model/RequestParams/Wall/EditAdsStealthParams.cs +++ b/VkNet/Model/RequestParams/Wall/EditAdsStealthParams.cs @@ -6,6 +6,9 @@ namespace VkNet.Model.RequestParams { + /// + /// TODO: Description + /// [Serializable] public class EditAdsStealthParams { diff --git a/VkNet/Utils/JsonConverter/SafetyEnumJsonConverter.cs b/VkNet/Utils/JsonConverter/SafetyEnumJsonConverter.cs index f5540c55c..d95d3dfef 100644 --- a/VkNet/Utils/JsonConverter/SafetyEnumJsonConverter.cs +++ b/VkNet/Utils/JsonConverter/SafetyEnumJsonConverter.cs @@ -6,13 +6,21 @@ namespace VkNet.Utils.JsonConverter { + /// + /// TODO: Description + /// public class SafetyEnumJsonConverter : Newtonsoft.Json.JsonConverter { + /// + /// TODO: Description + /// public override void WriteJson(JsonWriter writer, object value, JsonSerializer serializer) { throw new NotImplementedException(); } - + /// + /// TODO: Description + /// public override object ReadJson(JsonReader reader, Type objectType, object existingValue, JsonSerializer serializer) { @@ -37,7 +45,9 @@ public override object ReadJson(JsonReader reader, Type objectType, object exist return result; } - + /// + /// TODO: Description + /// public override bool CanConvert(Type objectType) { throw new NotImplementedException();