[Refactor] Refactor some stuff (#2688)
* fix some `internal` classes being exposed * update xmldoc comments to use `<see langword>` * bump library version in samples * fix possible oversight
This commit is contained in:
@@ -15,7 +15,7 @@ namespace Discord.Interactions
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <see cref="Preconditions" /> of the same group require only one of the preconditions to pass in order to
|
||||
/// be successful (A || B). Specifying <see cref="Group" /> = <c>null</c> or not at all will
|
||||
/// be successful (A || B). Specifying <see cref="Group" /> = <see langword="null" /> or not at all will
|
||||
/// require *all* preconditions to pass, just like normal (A && B).
|
||||
/// </remarks>
|
||||
public string Group { get; set; } = null;
|
||||
|
||||
@@ -250,7 +250,7 @@ namespace Discord.Interactions
|
||||
/// Create and loads a <see cref="ModuleInfo"/> using a builder factory.
|
||||
/// </summary>
|
||||
/// <param name="name">Name of the module.</param>
|
||||
/// <param name="services">The <see cref="IServiceProvider"/> for your dependency injection solution if using one; otherwise, pass <c>null</c>.</param>
|
||||
/// <param name="services">The <see cref="IServiceProvider"/> for your dependency injection solution if using one; otherwise, pass <see langword="null" />.</param>
|
||||
/// <param name="buildFunc">Module builder factory.</param>
|
||||
/// <returns>
|
||||
/// A task representing the operation for adding modules. The task result contains the built module instance.
|
||||
@@ -280,7 +280,7 @@ namespace Discord.Interactions
|
||||
/// Discover and load command modules from an <see cref="Assembly"/>.
|
||||
/// </summary>
|
||||
/// <param name="assembly"><see cref="Assembly"/> the command modules are defined in.</param>
|
||||
/// <param name="services">The <see cref="IServiceProvider"/> for your dependency injection solution if using one; otherwise, pass <c>null</c>.</param>
|
||||
/// <param name="services">The <see cref="IServiceProvider"/> for your dependency injection solution if using one; otherwise, pass <see langword="null" />.</param>
|
||||
/// <returns>
|
||||
/// A task representing the operation for adding modules. The task result contains a collection of the modules added.
|
||||
/// </returns>
|
||||
@@ -312,7 +312,7 @@ namespace Discord.Interactions
|
||||
/// Add a command module from a <see cref="Type"/>.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">Type of the module.</typeparam>
|
||||
/// <param name="services">The <see cref="IServiceProvider" /> for your dependency injection solution if using one; otherwise, pass <c>null</c> .</param>
|
||||
/// <param name="services">The <see cref="IServiceProvider" /> for your dependency injection solution if using one; otherwise, pass <see langword="null" /> .</param>
|
||||
/// <returns>
|
||||
/// A task representing the operation for adding the module. The task result contains the built module.
|
||||
/// </returns>
|
||||
@@ -329,7 +329,7 @@ namespace Discord.Interactions
|
||||
/// Add a command module from a <see cref="Type"/>.
|
||||
/// </summary>
|
||||
/// <param name="type">Type of the module.</param>
|
||||
/// <param name="services">The <see cref="IServiceProvider" /> for your dependency injection solution if using one; otherwise, pass <c>null</c> .</param>
|
||||
/// <param name="services">The <see cref="IServiceProvider" /> for your dependency injection solution if using one; otherwise, pass <see langword="null" /> .</param>
|
||||
/// <returns>
|
||||
/// A task representing the operation for adding the module. The task result contains the built module.
|
||||
/// </returns>
|
||||
|
||||
@@ -91,7 +91,7 @@ namespace Discord.Interactions
|
||||
/// Gets a string that indicates the autocompletion result.
|
||||
/// </summary>
|
||||
/// <returns>
|
||||
/// <c>Success</c> if <see cref="IsSuccess"/> is <c>true</c>; otherwise "<see cref="Error"/>:
|
||||
/// <c>Success</c> if <see cref="IsSuccess"/> is <see langword="true" />; otherwise "<see cref="Error"/>:
|
||||
/// <see cref="ErrorReason"/>".
|
||||
/// </returns>
|
||||
public override string ToString() => IsSuccess ? "Success" : $"{Error}: {ErrorReason}";
|
||||
|
||||
@@ -17,7 +17,7 @@ namespace Discord.Interactions
|
||||
/// <summary>
|
||||
/// Initializes a new <see cref="RuntimeResult" /> class with the type of error and reason.
|
||||
/// </summary>
|
||||
/// <param name="error">The type of failure, or <c>null</c> if none.</param>
|
||||
/// <param name="error">The type of failure, or <see langword="null" /> if none.</param>
|
||||
/// <param name="reason">The reason of failure.</param>
|
||||
protected RuntimeResult(InteractionCommandError? error, string reason)
|
||||
{
|
||||
@@ -29,7 +29,7 @@ namespace Discord.Interactions
|
||||
/// Gets a string that indicates the runtime result.
|
||||
/// </summary>
|
||||
/// <returns>
|
||||
/// <c>Success</c> if <see cref="IsSuccess"/> is <c>true</c>; otherwise "<see cref="Error"/>:
|
||||
/// <c>Success</c> if <see cref="IsSuccess"/> is <see langword="true" />; otherwise "<see cref="Error"/>:
|
||||
/// <see cref="ErrorReason"/>".
|
||||
/// </returns>
|
||||
public override string ToString() => ErrorReason ?? (IsSuccess ? "Successful" : "Unsuccessful");
|
||||
|
||||
Reference in New Issue
Block a user