Исправляет некорректно установленный inheritdoc

vknet · Feb 18, 2024 · 58fc173 · 58fc173
1 parent 33760d7
commit 58fc173
Show file tree

Hide file tree

Showing 51 changed files with 179 additions and 70 deletions.
diff --git a/VkNet/Abstractions/Authorization/IImplicitFlow.cs b/VkNet/Abstractions/Authorization/IImplicitFlow.cs
@@ -4,7 +4,6 @@
 
 namespace VkNet.Abstractions.Authorization;
 
-/// <inheritdoc />
 /// <summary>
 /// Implicit flow — самый короткий и простой вариант.
 /// Ключ возвращается на устройство пользователя, где был открыт диалог авторизации

diff --git a/VkNet/Abstractions/Category/IAccountCategory.cs b/VkNet/Abstractions/Category/IAccountCategory.cs
@@ -6,7 +6,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IAccountCategoryAsync"/>
+/// <summary>
+/// Методы этого класса позволяют производить действия с аккаунтом пользователя.
+/// </summary>
 public interface IAccountCategory : IAccountCategoryAsync
 {
 	/// <inheritdoc cref="IAccountCategoryAsync.GetCountersAsync"/>

diff --git a/VkNet/Abstractions/Category/IAdsCategory.cs b/VkNet/Abstractions/Category/IAdsCategory.cs
@@ -6,7 +6,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IAdsCategoryAsync"/>
+/// <summary>
+/// Методы для работы с рекламным кабинетом пользователя.
+/// </summary>
 public interface IAdsCategory : IAdsCategoryAsync
 {
 	/// <inheritdoc cref="IAdsCategoryAsync.AddOfficeUsersAsync"/>

diff --git a/VkNet/Abstractions/Category/IAppWidgetsCategory.cs b/VkNet/Abstractions/Category/IAppWidgetsCategory.cs
@@ -5,7 +5,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IAppWidgetsCategoryAsync"/>
+/// <summary>
+/// Список методов секции appWidgets
+/// </summary>
 public interface IAppWidgetsCategory : IAppWidgetsCategoryAsync
 {
 	/// <inheritdoc cref="IAppWidgetsCategoryAsync.GetAppImageUploadServerAsync"/>
@@ -29,7 +31,6 @@ public interface IAppWidgetsCategory : IAppWidgetsCategoryAsync
 	/// <inheritdoc cref="IAppWidgetsCategoryAsync.SaveGroupImageAsync"/>
 	AppImage SaveGroupImage(string hash, string image);
 
-	//TODO: TEST IT!!
 	/// <inheritdoc cref="IAppWidgetsCategoryAsync.UpdateAsync"/>
 	bool Update(string code, AppWidgetType type);
 }
diff --git a/VkNet/Abstractions/Category/IAppsCategory.cs b/VkNet/Abstractions/Category/IAppsCategory.cs
@@ -5,7 +5,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IAppsCategoryAsync"/>
+/// <summary>
+/// Методы для работы с методами приложений.
+/// </summary>
 public interface IAppsCategory : IAppsCategoryAsync
 {
 	/// <inheritdoc cref="IAppsCategoryAsync.GetCatalogAsync"/>

diff --git a/VkNet/Abstractions/Category/IAsrCategory.cs b/VkNet/Abstractions/Category/IAsrCategory.cs
@@ -3,7 +3,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IAsrCategoryAsync"/>
+/// <summary>
+/// Методы для работы с ASR
+/// </summary>
 public interface IAsrCategory : IAsrCategoryAsync
 {
 	/// <inheritdoc cref = "IAsrCategoryAsync.CheckStatusAsync"/>

diff --git a/VkNet/Abstractions/Category/IAudioCategory.cs b/VkNet/Abstractions/Category/IAudioCategory.cs
@@ -6,7 +6,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IAudioCategoryAsync" />
+/// <summary>
+/// Методы для работы с аудиозаписями.
+/// </summary>
 public interface IAudioCategory : IAudioCategoryAsync
 {
 	/// <inheritdoc cref="IAudioCategoryAsync.AddAsync"/>

diff --git a/VkNet/Abstractions/Category/IAuthCategory.cs b/VkNet/Abstractions/Category/IAuthCategory.cs
@@ -2,7 +2,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IAuthCategoryAsync" />
+/// <summary>
+/// Методы для работы с авторизацией.
+/// </summary>
 public interface IAuthCategory : IAuthCategoryAsync
 {
 	/// <inheritdoc cref="IAuthCategoryAsync.CheckPhoneAsync"/>

diff --git a/VkNet/Abstractions/Category/IBoardCategory.cs b/VkNet/Abstractions/Category/IBoardCategory.cs
@@ -3,7 +3,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IBoardCategoryAsync" />
+/// <summary>
+/// Методы для работы со темами группы.
+/// </summary>
 public interface IBoardCategory : IBoardCategoryAsync
 {
 	/// <inheritdoc cref="IBoardCategoryAsync.GetTopicsAsync"/>

diff --git a/VkNet/Abstractions/Category/IDatabaseCategory.cs b/VkNet/Abstractions/Category/IDatabaseCategory.cs
@@ -6,7 +6,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IDatabaseCategoryAsync" />
+/// <summary>
+/// Методы для получения справочной информации (страны, города, школы, учебные заведения и т.п.).
+/// </summary>
 public interface IDatabaseCategory : IDatabaseCategoryAsync
 {
 	/// <inheritdoc cref="IDatabaseCategoryAsync.GetCountriesAsync"/>

diff --git a/VkNet/Abstractions/Category/IDocsCategory.cs b/VkNet/Abstractions/Category/IDocsCategory.cs
@@ -7,7 +7,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IDocsCategoryAsync" />
+/// <summary>
+/// Методы для работы с документами (получение списка, загрузка, удаление и т.д.)
+/// </summary>
 public interface IDocsCategory : IDocsCategoryAsync
 {
 	/// <inheritdoc cref="IDocsCategoryAsync.GetAsync"/>
@@ -31,8 +33,6 @@ public interface IDocsCategory : IDocsCategoryAsync
 	/// <inheritdoc cref="IDocsCategoryAsync.AddAsync(long,long,string, System.Threading.CancellationToken)"/>
 	long Add(long ownerId, long docId, string accessKey = null);
 
-
-
 	/// <inheritdoc cref="IDocsCategoryAsync.GetTypesAsync"/>
 	VkCollection<DocumentType> GetTypes(long ownerId);
 

diff --git a/VkNet/Abstractions/Category/IDonutCategory.cs b/VkNet/Abstractions/Category/IDonutCategory.cs
@@ -4,8 +4,10 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IDonutCategoryAsync"/>
-public interface IDonutCategory
+/// <summary>
+/// Методы для работы с VK Donut.
+/// </summary>
+public interface IDonutCategory : IDonutCategoryAsync
 {
 	/// <inheritdoc cref="IDonutCategoryAsync.IsDonAsync"/>
 	bool IsDon(long ownerId);

diff --git a/VkNet/Abstractions/Category/IDownloadedGamesCategory.cs b/VkNet/Abstractions/Category/IDownloadedGamesCategory.cs
@@ -2,7 +2,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IDownloadedGamesCategoryAsync"/>
+/// <summary>
+/// Список методов секции downloadedGames
+/// </summary>
 public interface IDownloadedGamesCategory : IDownloadedGamesCategoryAsync
 {
 	/// <inheritdoc cref = "IDownloadedGamesCategoryAsync.GetPaidStatusAsync"/>

diff --git a/VkNet/Abstractions/Category/IExecuteCategory.cs b/VkNet/Abstractions/Category/IExecuteCategory.cs
@@ -2,7 +2,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IExecuteCategoryAsync" />
+/// <summary>
+/// Методы этого класса позволяют производить действия с универсальным методом.
+/// </summary>
 public interface IExecuteCategory : IExecuteCategoryAsync
 {
 	/// <inheritdoc cref="IExecuteCategoryAsync.ExecuteAsync"/>

diff --git a/VkNet/Abstractions/Category/IFaveCategory.cs b/VkNet/Abstractions/Category/IFaveCategory.cs
@@ -6,7 +6,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IFaveCategoryAsync" />
+/// <summary>
+/// Методы для работы с закладками.
+/// </summary>
 public partial interface IFaveCategory : IFaveCategoryAsync
 {
 	/// <inheritdoc cref = "IFaveCategoryAsync.AddArticleAsync"/>

diff --git a/VkNet/Abstractions/Category/IFaveCategoryObsolete.cs b/VkNet/Abstractions/Category/IFaveCategoryObsolete.cs
@@ -4,7 +4,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IFaveCategoryAsync" />
+/// <summary>
+/// Методы для работы с закладками.
+/// </summary>
 public partial interface IFaveCategory
 {
 	/// <inheritdoc cref="IFaveCategoryAsync.GetUsersAsync" />

diff --git a/VkNet/Abstractions/Category/IFriendsCategory.cs b/VkNet/Abstractions/Category/IFriendsCategory.cs
@@ -9,7 +9,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IFriendsCategoryAsync" />
+/// <summary>
+/// Методы для работы с друзьями.
+/// </summary>
 public interface IFriendsCategory : IFriendsCategoryAsync
 {
 	/// <inheritdoc cref="IFriendsCategoryAsync.GetAsync" />

diff --git a/VkNet/Abstractions/Category/IGiftsCategory.cs b/VkNet/Abstractions/Category/IGiftsCategory.cs
@@ -3,7 +3,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IGiftsCategoryAsync" />
+/// <summary>
+/// Методы для работы с подарками.
+/// </summary>
 public interface IGiftsCategory : IGiftsCategoryAsync
 {
 	/// <inheritdoc cref="IGiftsCategoryAsync.GetAsync" />

diff --git a/VkNet/Abstractions/Category/IGroupsCategory.cs b/VkNet/Abstractions/Category/IGroupsCategory.cs
@@ -8,7 +8,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IGroupsCategoryAsync" />
+/// <summary>
+/// Асинхронные методы для работы с сообществами (группами).
+/// </summary>
 public interface IGroupsCategory : IGroupsCategoryAsync
 {
 	/// <inheritdoc cref="IGroupsCategoryAsync.AddAddressAsync" />
@@ -45,7 +47,7 @@ ReadOnlyCollection<GroupMember> IsMember(string groupId, IEnumerable<long> userI
 
 	/// <inheritdoc cref="IGroupsCategoryAsync.IsMemberAsync(string, long, bool?, bool, System.Threading.CancellationToken)" />
 	GroupMember IsMember(string groupId, long userId, bool? extended = true,
-											bool skipAuthorization = false);
+						bool skipAuthorization = false);
 
 	/// <inheritdoc cref="IGroupsCategoryAsync.IsMemberAsync(string, long, bool, System.Threading.CancellationToken)" />
 	bool IsMember(string groupId, long userId, bool skipAuthorization = false);
@@ -86,7 +88,6 @@ VkCollection<User> GetInvitedUsers(long groupId, long? offset = null, long? coun
 	/// <inheritdoc cref="IGroupsCategoryAsync.InviteAsync(long,long, System.Threading.CancellationToken)" />
 	bool Invite(long groupId, long userId);
 
-
 	/// <inheritdoc cref="IGroupsCategoryAsync.AddLinkAsync" />
 	ExternalLink AddLink(long groupId, Uri link, string text);
 

diff --git a/VkNet/Abstractions/Category/ILeadFormsCategory.cs b/VkNet/Abstractions/Category/ILeadFormsCategory.cs
@@ -5,7 +5,9 @@
 
 namespace VkNet.Abstractions.Category;
 
-/// <inheritdoc cref="ILeadFormsCategoryAsync" />
+/// <summary>
+/// Формы сбора заявок Подойдут для записи клиентов, предварительной регистрации, подписки на рассылки, запросов информации, подключения услуг, оформления заказов и многого другого. Вы создаете формы с заявками, а пользователи оставляют свою контактную информацию. Вам остается завершить оформление заявки, связавшись с ними удобным способом.
+/// </summary>
 public interface ILeadFormsCategory : ILeadFormsCategoryAsync
 {
 	/// <inheritdoc cref="ILeadFormsCategoryAsync.CreateAsync" />

diff --git a/VkNet/Abstractions/Category/ILeadsCategory.cs b/VkNet/Abstractions/Category/ILeadsCategory.cs
@@ -3,7 +3,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="ILeadsCategoryAsync" />
+/// <summary>
+/// Leads При подключении к сервису рекламных акций партнёр получает доступ в специальный раздел для создания и управления рекламными акциями (офферами).
+/// </summary>
 public interface ILeadsCategory : ILeadsCategoryAsync
 {
 	/// <inheritdoc cref="ILeadsCategoryAsync.CheckUserAsync" />

diff --git a/VkNet/Abstractions/Category/ILikesCategory.cs b/VkNet/Abstractions/Category/ILikesCategory.cs
@@ -4,7 +4,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="ILikesCategoryAsync" />
+/// <summary>
+/// Методы для работы с лайками.
+/// </summary>
 public interface ILikesCategory : ILikesCategoryAsync
 {
 	/// <inheritdoc cref="ILikesCategoryAsync.GetListAsync" />
@@ -19,7 +21,6 @@ public interface ILikesCategory : ILikesCategoryAsync
 	/// <inheritdoc cref="ILikesCategoryAsync.DeleteAsync(LikeObjectType, long, long?, System.Threading.CancellationToken)" />
 	long Delete(LikeObjectType type, long itemId, long? ownerId = null);
 
-
 	/// <inheritdoc cref="ILikesCategoryAsync.IsLikedAsync" />
 	bool IsLiked(out bool copied, LikeObjectType type, long itemId, long? userId = null, long? ownerId = null);
 }
diff --git a/VkNet/Abstractions/Category/IMarketsCategory.cs b/VkNet/Abstractions/Category/IMarketsCategory.cs
@@ -5,7 +5,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IMarketsCategoryAsync"/>
+/// <summary>
+/// Методы для работы с товарами.
+/// </summary>
 public interface IMarketsCategory : IMarketsCategoryAsync
 {
 	/// <inheritdoc cref="IMarketsCategoryAsync.GetAsync"/>
@@ -69,7 +71,8 @@ public interface IMarketsCategory : IMarketsCategoryAsync
 	long AddAlbum(long ownerId, string title, long? photoId = null, bool mainAlbum = false, bool isHidden = false);
 
 	/// <inheritdoc cref="IMarketsCategoryAsync.EditAlbumAsync"/>
-	bool EditAlbum(long ownerId, long albumId, string title, long? photoId = null, bool mainAlbum = false, bool isHidden = false);
+	bool EditAlbum(long ownerId, long albumId, string title, long? photoId = null, bool mainAlbum = false,
+					bool isHidden = false);
 
 	/// <inheritdoc cref="IMarketsCategoryAsync.DeleteAlbumAsync"/>
 	bool DeleteAlbum(long ownerId, long albumId);

diff --git a/VkNet/Abstractions/Category/IMessagesCategory.cs b/VkNet/Abstractions/Category/IMessagesCategory.cs
@@ -9,7 +9,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IMessagesCategoryAsync"/>
+/// <summary>
+/// Методы для работы с личными сообщениями. Для моментального получения входящих сообщений используйте LongPoll сервер.
+/// </summary>
 public interface IMessagesCategory : IMessagesCategoryAsync
 {
 	/// <inheritdoc cref="IMessagesCategoryAsync.AddChatUserAsync"/>
@@ -165,7 +167,6 @@ GetRecentCallsResult GetRecentCalls(IEnumerable<string> fields, ulong? count = n
 	/// <inheritdoc cref="IMessagesCategoryAsync.GetIntentUsersAsync"/>
 	GetIntentUsersResult GetIntentUsers(MessagesGetIntentUsersParams getIntentUsersParams);
 
-
 	/// <inheritdoc cref="IMessagesCategoryAsync.SetMemberRoleAsync"/>
 	bool SetMemberRole(string role, long peerId, ulong memberId);
 

diff --git a/VkNet/Abstractions/Category/INewsFeedCategory.cs b/VkNet/Abstractions/Category/INewsFeedCategory.cs
@@ -7,7 +7,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="INewsFeedCategoryAsync"/>
+/// <summary>
+/// Методы для работы с новостной лентой пользователя.
+/// </summary>
 public interface INewsFeedCategory : INewsFeedCategoryAsync
 {
 	/// <inheritdoc cref="INewsFeedCategoryAsync.GetAsync"/>

diff --git a/VkNet/Abstractions/Category/INotesCategory.cs b/VkNet/Abstractions/Category/INotesCategory.cs
@@ -4,7 +4,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="INotesCategoryAsync"/>
+/// <summary>
+/// Методы для работы с заметками.
+/// </summary>
 public interface INotesCategory : INotesCategoryAsync
 {
 	/// <inheritdoc cref="INotesCategoryAsync.AddAsync"/>

diff --git a/VkNet/Abstractions/Category/INotificationsCategory.cs b/VkNet/Abstractions/Category/INotificationsCategory.cs
@@ -3,7 +3,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="INotificationsCategoryAsync"/>
+/// <summary>
+/// Методы для работы с Уведомлениями
+/// </summary>
 public interface INotificationsCategory : INotificationsCategoryAsync
 {
 	/// <inheritdoc cref="INotificationsCategoryAsync.GetAsync"/>

diff --git a/VkNet/Abstractions/Category/IOrdersCategory.cs b/VkNet/Abstractions/Category/IOrdersCategory.cs
@@ -5,7 +5,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IOrdersCategoryAsync"/>
+/// <summary>
+/// Методы этой секции предоставляют дополнительную возможность управления состоянием заказов, которые были сделаны пользователями в приложениях.
+/// </summary>
 public interface IOrdersCategory : IOrdersCategoryAsync
 {
 	/// <inheritdoc cref="IOrdersCategoryAsync.CancelSubscriptionAsync"/>

diff --git a/VkNet/Abstractions/Category/IPagesCategory.cs b/VkNet/Abstractions/Category/IPagesCategory.cs
@@ -5,7 +5,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IPagesCategoryAsync"/>
+/// <summary>
+/// Методы для работы с wiki.
+/// </summary>
 public interface IPagesCategory : IPagesCategoryAsync
 {
 	/// <inheritdoc cref="IPagesCategoryAsync.GetAsync"/>

diff --git a/VkNet/Abstractions/Category/IPhotoCategory.cs b/VkNet/Abstractions/Category/IPhotoCategory.cs
@@ -6,7 +6,9 @@
 
 namespace VkNet.Abstractions;
 
-/// <inheritdoc cref="IPhotoCategoryAsync"/>
+/// <summary>
+/// Методы для работы с фотографиями.
+/// </summary>
 public interface IPhotoCategory : IPhotoCategoryAsync
 {
 	/// <inheritdoc cref="IPhotoCategoryAsync.CreateAlbumAsync"/>
@@ -42,7 +44,6 @@ ReadOnlyCollection<Photo> GetById(IEnumerable<string> photos
 	/// <inheritdoc cref="IPhotoCategoryAsync.SaveOwnerPhotoAsync(string, System.Threading.CancellationToken)"/>
 	Photo SaveOwnerPhoto(string response);
 
-
 	/// <inheritdoc cref="IPhotoCategoryAsync.SaveWallPhotoAsync"/>
 	ReadOnlyCollection<Photo> SaveWallPhoto(string response, ulong? userId, ulong? groupId = null, string caption = null);