cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-29 08:00:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation warnings

Browse Source
This commit is contained in:
Jordan Brown
2021-01-04 13:37:51 -05:00
parent a80c5ca22f
commit 2a08b4d182
2 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Tgstation.Server.Host/Components/Chat/ChatManager.cs
+2 -2
View File
@@ -67,7 +67,7 @@ namespace Tgstation.Server.Host.Components.Chat
readonly IDictionary<string, ICommand> builtinCommands;
/// <summary>
/// Map of <see cref="IProvider"/>s in use, keyed by <see cref="ChatBot.Id"/>
/// Map of <see cref="IProvider"/>s in use, keyed by <see cref="ChatBot"/> <see cref="Api.Models.EntityId.Id"/>
/// </summary>
readonly IDictionary<long, IProvider> providers;
@@ -184,7 +184,7 @@ namespace Tgstation.Server.Host.Components.Chat
/// <summary>
/// Remove a <see cref="IProvider"/> from <see cref="providers"/> and <see cref="mappedChannels"/> optionally updating the <see cref="trackingContexts"/> as well
/// </summary>
/// <param name="connectionId">The <see cref="ChatBot.Id"/> of the <see cref="IProvider"/> to delete</param>
/// <param name="connectionId">The <see cref="Api.Models.EntityId.Id"/> of the <see cref="IProvider"/> to delete</param>
/// <param name="updateTrackings">If <see cref="trackingContexts"/> should be update</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation.</param>
/// <returns>A <see cref="Task{TResult}"/> resulting in the <see cref="IProvider"/> being removed if it exists, <see langword="null"/> otherwise.</returns>
src/Tgstation.Server.Host/Components/Chat/IChatManager.cs
+3 -3
View File
@@ -19,7 +19,7 @@ namespace Tgstation.Server.Host.Components.Chat
void RegisterCommandHandler(ICustomCommandHandler customCommandHandler);
/// <summary>
/// Change chat settings. If the <see cref="ChatBot.Id"/> is not currently in use, a new connection will be made instead
/// Change chat settings. If the <see cref="Api.Models.EntityId.Id"/> is not currently in use, a new connection will be made instead
/// </summary>
/// <param name="newSettings">The new <see cref="Models.ChatBot"/></param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation</param>
@@ -29,7 +29,7 @@ namespace Tgstation.Server.Host.Components.Chat
/// <summary>
/// Disconnects and deletes a given connection
/// </summary>
/// <param name="connectionId">The <see cref="ChatBot.Id"/> of the connection</param>
/// <param name="connectionId">The <see cref="Api.Models.EntityId.Id"/> of the connection</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation</param>
/// <returns>A <see cref="Task"/> representing the running operation</returns>
Task DeleteConnection(long connectionId, CancellationToken cancellationToken);
@@ -37,7 +37,7 @@ namespace Tgstation.Server.Host.Components.Chat
/// <summary>
/// Change chat channels
/// </summary>
/// <param name="connectionId">The <see cref="ChatBot.Id"/> of the connection</param>
/// <param name="connectionId">The <see cref="Api.Models.EntityId.Id"/> of the connection</param>
/// <param name="newChannels">An <see cref="IEnumerable{T}"/> of the new list of <see cref="Api.Models.ChatChannel"/>s</param>
/// <param name="cancellationToken">The <see cref="CancellationToken"/> for the operation</param>
/// <returns>A <see cref="Task"/> representing the running operation</returns>