Refactoring

Fix some methods and properties description Left TODO marks on unkommented methods and classes
vknet · Mar 2, 2018 · 9be68c8 · 9be68c8
1 parent fde1d8b
commit 9be68c8
Show file tree

Hide file tree

Showing 8 changed files with 96 additions and 83 deletions.
diff --git a/VkNet/Abstractions/Async/IDatabaseCategoryAsync.cs b/VkNet/Abstractions/Async/IDatabaseCategoryAsync.cs
@@ -66,17 +66,17 @@ public interface IDatabaseCategoryAsync
         /// <summary>
         /// Возвращает список городов.
         /// </summary>
-        /// <param name="params">Параметры запроса database.getCities</param>
+        /// <param name="parameters">Параметры запроса database.getCities</param>
         /// <returns>Cписок городов</returns>
         /// <remarks>
         /// Возвращает коллекцию городов, каждый из которых содержит поля City.Id
         /// При наличии информации о регионе и/или области, в которых находится данный город, в объекте могут дополнительно
         /// включаться поля City.Area
-        /// Если не задан параметр <paramref name="@params.query"/>, то будет возвращен список самых крупных городов в заданной стране.
-        /// Если задан параметр <paramref name="@params.query"/>, то будет возвращен список городов, которые релевантны поисковому запросу.
+        /// Если не задан параметр <paramref name="parameters.query"/>, то будет возвращен список самых крупных городов в заданной стране.
+        /// Если задан параметр <paramref name="parameters.query"/>, то будет возвращен список городов, которые релевантны поисковому запросу.
         /// Страница документации ВКонтакте http://vk.com/dev/database.getCities
         /// </remarks>
-        Task<VkCollection<City>> GetCitiesAsync(GetCitiesParams @params);
+        Task<VkCollection<City>> GetCitiesAsync(GetCitiesParams parameters);
 
         /// <summary>
         /// Возвращает информацию о городах по их идентификаторам.

diff --git a/VkNet/Abstractions/Async/IMessagesCategoryAsync.cs b/VkNet/Abstractions/Async/IMessagesCategoryAsync.cs
@@ -427,20 +427,19 @@ Task<ReadOnlyCollection<Chat>> GetChatAsync(IEnumerable<long> chatIds, ProfileFi
         /// <summary>
         /// Отправляет стикер.
         /// </summary>
-        /// <param name="params">Параметры запроса.</param>
+        /// <param name="parameters">Параметры запроса.</param>
         /// <returns>
         /// После успешного выполнения возвращает идентификатор отправленного сообщения (mid).
         /// </returns>
         /// <remarks>
         /// Страница документации ВКонтакте http://vk.com/dev/messages.sendSticker
         /// </remarks>
-        Task<long> SendStickerAsync(MessagesSendStickerParams @params);
+        Task<long> SendStickerAsync(MessagesSendStickerParams parameters);
 
         /// <summary>
         /// Возвращает материалы диалога или беседы..
         /// </summary>
         /// <param name="params">Параметры запроса.</param>
-        /// <param name="nextFrom">Новое значение start_from. </param>
         /// <returns>
         /// После успешного выполнения возвращает массив объектов 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
@@ -65,17 +65,17 @@ public interface IDatabaseCategory : IDatabaseCategoryAsync
         /// <summary>
         /// Возвращает список городов.
         /// </summary>
-        /// <param name="params">Параметры запроса database.getCities</param>
+        /// <param name="parameters">Параметры запроса database.getCities</param>
         /// <returns>Cписок городов</returns>
         /// <remarks>
         /// Возвращает коллекцию городов, каждый из которых содержит поля City.Id
         /// При наличии информации о регионе и/или области, в которых находится данный город, в объекте могут дополнительно
         /// включаться поля City.Area
-        /// Если не задан параметр <paramref name="@params.query"/>, то будет возвращен список самых крупных городов в заданной стране.
-        /// Если задан параметр <paramref name="@params.query"/>, то будет возвращен список городов, которые релевантны поисковому запросу.
+        /// Если не задан параметр <paramref name="parameters.query"/>, то будет возвращен список самых крупных городов в заданной стране.
+        /// Если задан параметр <paramref name="parameters.query"/>, то будет возвращен список городов, которые релевантны поисковому запросу.
         /// Страница документации ВКонтакте http://vk.com/dev/database.getCities
         /// </remarks>
-        VkCollection<City> GetCities(GetCitiesParams @params);
+        VkCollection<City> GetCities(GetCitiesParams parameters);
 
         /// <summary>
         /// Возвращает информацию о городах по их идентификаторам.

diff --git a/VkNet/Abstractions/IVkApiInvoke.cs b/VkNet/Abstractions/IVkApiInvoke.cs
@@ -6,6 +6,9 @@
 
 namespace VkNet.Abstractions
 {
+    /// <summary>
+    /// TODO: Description
+    /// </summary>
     public interface IVkApiInvoke
     {
         /// <summary>

diff --git 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"];
 		}
 
-		/// <summary>
-		/// Редактирует подборку с товарами.
-		/// </summary>
-		/// <param name="ownerId">Идентификатор владельца подборки. Обратите внимание, идентификатор сообщества в параметре owner_id необходимо указывать со знаком "-" — например, owner_id=-1 соответствует идентификатору сообщества ВКонтакте API (club1)  целое число, обязательный параметр (целое число, обязательный параметр).</param>
-		/// <param name="albumId">Идентификатор подборки. положительное число, обязательный параметр (положительное число, обязательный параметр).</param>
-		/// <param name="title">Название подборки. строка, обязательный параметр, максимальная длина 128 (строка, обязательный параметр, максимальная длина 128).</param>
-		/// <param name="photoId">Идентификатор фотографии-обложки подборки. положительное число (положительное число).</param>
-		/// <returns>
-		/// После успешного выполнения возвращает 1.
-		/// </returns>
-		/// <remarks>
-		/// Страница документации ВКонтакте http://vk.com/dev/market.editAlbum
-		/// </remarks>
-		public bool EditAlbum(long ownerId, long albumId, string title, long? photoId = null, bool mainAlbum = false)
+        /// <summary>
+        /// Редактирует подборку с товарами.
+        /// </summary>
+        /// <param name="ownerId">Идентификатор владельца подборки. Обратите внимание, идентификатор сообщества в параметре owner_id необходимо указывать со знаком "-" — например, owner_id=-1 соответствует идентификатору сообщества ВКонтакте API (club1)  целое число, обязательный параметр (целое число, обязательный параметр).</param>
+        /// <param name="albumId">Идентификатор подборки. положительное число, обязательный параметр (положительное число, обязательный параметр).</param>
+        /// <param name="title">Название подборки. строка, обязательный параметр, максимальная длина 128 (строка, обязательный параметр, максимальная длина 128).</param>
+        /// <param name="photoId">Идентификатор фотографии-обложки подборки. положительное число (положительное число).</param>
+        /// <param name="mainAlbum">Назначить подборку основной.</param>
+        /// <returns>
+        /// После успешного выполнения возвращает 1.
+        /// </returns>
+        /// <remarks>
+        /// Страница документации ВКонтакте http://vk.com/dev/market.editAlbum
+        /// </remarks>
+        public bool EditAlbum(long ownerId, long albumId, string title, long? photoId = null, bool mainAlbum = false)
 		{
 			var parameters = new VkParameters {
 				{ "owner_id", ownerId },