1
0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-09 22:55:42 +00:00

(#15) Improve xmldoc bool returns

Changed ",or false otherwise" to "; otherwise, false."
This commit is contained in:
Oliver Booth 2022-02-14 12:07:30 +00:00
parent 64cadbe87d
commit 5ec4e06d9d
7 changed files with 22 additions and 16 deletions

View File

@ -1,4 +1,4 @@
namespace X10D
namespace X10D
{
/// <summary>
/// Extension methods for <see cref="byte" />.
@ -46,7 +46,7 @@
/// </summary>
/// <param name="value">The value whose primality to check.</param>
/// <returns>
/// <see langword="true" /> if <paramref name="value" /> is prime, or <see langword="false" /> otherwise.
/// <see langword="true" /> if <paramref name="value" /> is prime; otherwise, <see langword="false" />.
/// </returns>
public static bool IsPrime(this byte value)
{

View File

@ -39,7 +39,7 @@ namespace X10D
/// </summary>
/// <param name="value">The value whose primality to check.</param>
/// <returns>
/// <see langword="true" /> if <paramref name="value" /> is prime, or <see langword="false" /> otherwise.
/// <see langword="true" /> if <paramref name="value" /> is prime; otherwise, <see langword="false" />.
/// </returns>
public static bool IsPrime(this sbyte value)
{

View File

@ -14,7 +14,7 @@ namespace X10D
/// <param name="source">The enum value which should be used as the starting point.</param>
/// <param name="wrap">
/// Optional. <see langword="true" /> if the final value of <typeparamref name="T" /> should wrap around to the first
/// value, or <see langword="false" /> otherwise. Defaults to <see langword="true" />.
/// value; otherwise, <see langword="false" />. Defaults to <see langword="true" />.
/// </param>
/// <returns>
/// A value of <typeparamref name="T" /> that is considered to be the next value defined after
@ -35,7 +35,7 @@ namespace X10D
/// <param name="source">The enum value which should be used as the starting point.</param>
/// <param name="wrap">
/// Optional. <see langword="true" /> if the first value of <typeparamref name="T" /> should wrap around to the final
/// value, or <see langword="false" /> otherwise. Defaults to <see langword="true" />.
/// value; otherwise, <see langword="false" />. Defaults to <see langword="true" />.
/// </param>
/// <returns>
/// A value of <typeparamref name="T" /> that is considered to be the previous value defined before

View File

@ -82,10 +82,12 @@ namespace X10D
}
/// <summary>
/// Returns a value indicating whether the current 16-bit signed integer is prime.
/// Returns a value indicating whether the current value is a prime number.
/// </summary>
/// <param name="value">The number to check.</param>
/// <returns><see langword="true" /> if <paramref name="value" /> is prime, or <see langword="false" /> otherwise.</returns>
/// <param name="value">The value whose primality to check.</param>
/// <returns>
/// <see langword="true" /> if <paramref name="value" /> is prime; otherwise, <see langword="false" />.
/// </returns>
public static bool IsPrime(this short value)
{
return ((long)value).IsPrime();

View File

@ -134,10 +134,12 @@ namespace X10D
}
/// <summary>
/// Returns a value indicating whether the current 32-bit signed integer is prime.
/// Returns a value indicating whether the current value is a prime number.
/// </summary>
/// <param name="value">The number to check.</param>
/// <returns><see langword="true" /> if <paramref name="value" /> is prime, or <see langword="false" /> otherwise.</returns>
/// <param name="value">The value whose primality to check.</param>
/// <returns>
/// <see langword="true" /> if <paramref name="value" /> is prime; otherwise, <see langword="false" />.
/// </returns>
public static bool IsPrime(this int value)
{
return ((long)value).IsPrime();

View File

@ -82,10 +82,12 @@ namespace X10D
}
/// <summary>
/// Returns a value indicating whether the current 64-bit signed integer is prime.
/// Returns a value indicating whether the current value is a prime number.
/// </summary>
/// <param name="value">The number to check.</param>
/// <returns><see langword="true" /> if <paramref name="value" /> is prime, or <see langword="false" /> otherwise.</returns>
/// <param name="value">The value whose primality to check.</param>
/// <returns>
/// <see langword="true" /> if <paramref name="value" /> is prime; otherwise, <see langword="false" />.
/// </returns>
public static bool IsPrime(this long value)
{
switch (value)

View File

@ -66,7 +66,7 @@ namespace X10D
/// </summary>
/// <param name="value">The type whose interface list to check.</param>
/// <typeparam name="T">The interface type.</typeparam>
/// <returns><see langword="true" /> if the current exists on the type, or <see langword="false" /> otherwise.</returns>
/// <returns><see langword="true" /> if the current exists on the type; otherwise, <see langword="false" />.</returns>
public static bool Implements<T>(this Type value)
{
return value.Implements(typeof(T));
@ -77,7 +77,7 @@ namespace X10D
/// </summary>
/// <param name="value">The type whose interface list to check.</param>
/// <param name="interfaceType">The interface type.</param>
/// <returns><see langword="true" /> if the current exists on the type, or <see langword="false" /> otherwise.</returns>
/// <returns><see langword="true" /> if the current exists on the type; otherwise, <see langword="false" />.</returns>
public static bool Implements(this Type value, Type interfaceType)
{
if (value is null)