Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Delete .github/workflows/snorkell-auto-documentation.yml +semver: minor #649

Merged
merged 1 commit into from
Jan 17, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 0 additions & 19 deletions .github/workflows/snorkell-auto-documentation.yml

This file was deleted.


Unchanged files with check annotations Beta

/// The key represents the error field or context, and the value is a collection of error messages related to that key.
/// </summary>
/// <value>
/// A dictionary where the key is a string representing the error field or context, and the value is an <see cref="IEnumerable{string}"/>

Check warning on line 16 in Src/CrispyWaffle/Utilities/ErrorResponse.cs

GitHub Actions / Deep Source Coverage report

XML comment has syntactically incorrect cref attribute 'IEnumerable{string}'

Check warning on line 16 in Src/CrispyWaffle/Utilities/ErrorResponse.cs

GitHub Actions / Deep Source Coverage report

Type parameter declaration must be an identifier not a type. See also error CS0081.

Check warning on line 16 in Src/CrispyWaffle/Utilities/ErrorResponse.cs

GitHub Actions / Analyze (csharp)

XML comment has syntactically incorrect cref attribute 'IEnumerable{string}'

Check warning on line 16 in Src/CrispyWaffle/Utilities/ErrorResponse.cs

GitHub Actions / Analyze (csharp)

Type parameter declaration must be an identifier not a type. See also error CS0081.

Check warning on line 16 in Src/CrispyWaffle/Utilities/ErrorResponse.cs

GitHub Actions / SonarCloud Analysis

XML comment has syntactically incorrect cref attribute 'IEnumerable{string}'

Check warning on line 16 in Src/CrispyWaffle/Utilities/ErrorResponse.cs

GitHub Actions / SonarCloud Analysis

Type parameter declaration must be an identifier not a type. See also error CS0081.
/// containing the error messages related to that field or context.
/// </value>
public Dictionary<string, IEnumerable<string>> ErrorList { get; set; }
/// The first <see cref="XmlNode"/> matching the tag name, or <c>null</c> if no matching elements are found.
/// </returns>
/// <remarks>
/// This method uses <see cref="XmlDocument.GetElementsByTagName"/> to get all elements with the specified tag

Check warning on line 51 in Src/CrispyWaffle/Extensions/XmlExtensions.cs

GitHub Actions / Deep Source Coverage report

Ambiguous reference in cref attribute: 'XmlDocument.GetElementsByTagName'. Assuming 'XmlDocument.GetElementsByTagName(string)', but could have also matched other overloads including 'XmlDocument.GetElementsByTagName(string, string)'.

Check warning on line 51 in Src/CrispyWaffle/Extensions/XmlExtensions.cs

GitHub Actions / Analyze (csharp)

Ambiguous reference in cref attribute: 'XmlDocument.GetElementsByTagName'. Assuming 'XmlDocument.GetElementsByTagName(string)', but could have also matched other overloads including 'XmlDocument.GetElementsByTagName(string, string)'.

Check warning on line 51 in Src/CrispyWaffle/Extensions/XmlExtensions.cs

GitHub Actions / SonarCloud Analysis

Ambiguous reference in cref attribute: 'XmlDocument.GetElementsByTagName'. Assuming 'XmlDocument.GetElementsByTagName(string)', but could have also matched other overloads including 'XmlDocument.GetElementsByTagName(string, string)'.
/// and returns the first element in the collection, if any.
/// </remarks>
public static XmlNode GetFirstElementByTagName(this XmlDocument document, string tagName)
/// The inner text of the child node if found; otherwise, an empty string.
/// </returns>
/// <remarks>
/// This method uses <see cref="XmlNode.SelectNodes"/> to select the child node by its name and fetches the

Check warning on line 69 in Src/CrispyWaffle/Extensions/XmlExtensions.cs

GitHub Actions / Deep Source Coverage report

Ambiguous reference in cref attribute: 'XmlNode.SelectNodes'. Assuming 'XmlNode.SelectNodes(string)', but could have also matched other overloads including 'XmlNode.SelectNodes(string, XmlNamespaceManager)'.

Check warning on line 69 in Src/CrispyWaffle/Extensions/XmlExtensions.cs

GitHub Actions / Analyze (csharp)

Ambiguous reference in cref attribute: 'XmlNode.SelectNodes'. Assuming 'XmlNode.SelectNodes(string)', but could have also matched other overloads including 'XmlNode.SelectNodes(string, XmlNamespaceManager)'.

Check warning on line 69 in Src/CrispyWaffle/Extensions/XmlExtensions.cs

GitHub Actions / SonarCloud Analysis

Ambiguous reference in cref attribute: 'XmlNode.SelectNodes'. Assuming 'XmlNode.SelectNodes(string)', but could have also matched other overloads including 'XmlNode.SelectNodes(string, XmlNamespaceManager)'.
/// <see cref="XmlNode.InnerText"/> if the node is found.
/// </remarks>
public static string GetNodeValue(this XmlNode xmlNode, string node)
/// If a node is not found, an empty string is used in its place.
/// </returns>
/// <remarks>
/// This method uses <see cref="XmlNode.SelectNodes"/> for each node name in the <paramref name="nodes"/>

Check warning on line 89 in Src/CrispyWaffle/Extensions/XmlExtensions.cs

GitHub Actions / Deep Source Coverage report

Ambiguous reference in cref attribute: 'XmlNode.SelectNodes'. Assuming 'XmlNode.SelectNodes(string)', but could have also matched other overloads including 'XmlNode.SelectNodes(string, XmlNamespaceManager)'.

Check warning on line 89 in Src/CrispyWaffle/Extensions/XmlExtensions.cs

GitHub Actions / Analyze (csharp)

Ambiguous reference in cref attribute: 'XmlNode.SelectNodes'. Assuming 'XmlNode.SelectNodes(string)', but could have also matched other overloads including 'XmlNode.SelectNodes(string, XmlNamespaceManager)'.

Check warning on line 89 in Src/CrispyWaffle/Extensions/XmlExtensions.cs

GitHub Actions / SonarCloud Analysis

Ambiguous reference in cref attribute: 'XmlNode.SelectNodes'. Assuming 'XmlNode.SelectNodes(string)', but could have also matched other overloads including 'XmlNode.SelectNodes(string, XmlNamespaceManager)'.
/// array, collects the values of the found nodes, and concatenates them into a single string with a space separator.
/// </remarks>
public static string GetNodeValue(this XmlNode xmlNode, string[] nodes)
/// <returns><c>true</c> if the log message should be filtered (i.e., not allowed to pass through), <c>false</c> otherwise.</returns>
/// <remarks>
/// If a provider type is specified, the log message will only pass through if it matches
/// the provided provider type. If the <paramref name="isExclusive"/> flag is set to <c>true</c>,

Check warning on line 50 in Src/CrispyWaffle/Log/Filters/CategoryLogFilter.cs

GitHub Actions / Deep Source Coverage report

XML comment on 'CategoryLogFilter.Filter(string, LogLevel, string, string)' has a paramref tag for 'isExclusive', but there is no parameter by that name

Check warning on line 50 in Src/CrispyWaffle/Log/Filters/CategoryLogFilter.cs

GitHub Actions / Analyze (csharp)

XML comment on 'CategoryLogFilter.Filter(string, LogLevel, string, string)' has a paramref tag for 'isExclusive', but there is no parameter by that name

Check warning on line 50 in Src/CrispyWaffle/Log/Filters/CategoryLogFilter.cs

GitHub Actions / SonarCloud Analysis

XML comment on 'CategoryLogFilter.Filter(string, LogLevel, string, string)' has a paramref tag for 'isExclusive', but there is no parameter by that name
/// the log message will only pass through if its category is one of the specified categories.
/// If the flag is set to <c>false</c>, the message will pass through only if its category
/// is not in the filter.
/// </exception>
public static string CalculateBrazilianPersonDocumentDigits(this string document)
{
int[] multiplierFirstDigit = [10, 9, 8, 7, 6, 5, 4, 3, 2];

Check warning on line 96 in Src/CrispyWaffle/Validations/PersonalDataValidation.cs

GitHub Actions / Deep Source Coverage report

Opening square brackets should not be preceded by a space. (https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1010.md)

Check warning on line 96 in Src/CrispyWaffle/Validations/PersonalDataValidation.cs

GitHub Actions / SonarCloud Analysis

Opening square brackets should not be preceded by a space. (https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1010.md)
int[] multiplierSecondDigit = [11, 10, 9, 8, 7, 6, 5, 4, 3, 2];

Check warning on line 97 in Src/CrispyWaffle/Validations/PersonalDataValidation.cs

GitHub Actions / Deep Source Coverage report

Opening square brackets should not be preceded by a space. (https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1010.md)

Check warning on line 97 in Src/CrispyWaffle/Validations/PersonalDataValidation.cs

GitHub Actions / SonarCloud Analysis

Opening square brackets should not be preceded by a space. (https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1010.md)
return CalculateDocumentDigits(
document,
/// </exception>
public static string CalculateBrazilianCorporateDocument(this string document)
{
int[] multiplierFirstDigit = [5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2];

Check warning on line 120 in Src/CrispyWaffle/Validations/PersonalDataValidation.cs

GitHub Actions / Deep Source Coverage report

Opening square brackets should not be preceded by a space. (https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1010.md)

Check warning on line 120 in Src/CrispyWaffle/Validations/PersonalDataValidation.cs

GitHub Actions / SonarCloud Analysis

Opening square brackets should not be preceded by a space. (https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1010.md)
int[] multiplierSecondDigit = [6, 5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2];

Check warning on line 121 in Src/CrispyWaffle/Validations/PersonalDataValidation.cs

GitHub Actions / Deep Source Coverage report

Opening square brackets should not be preceded by a space. (https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1010.md)

Check warning on line 121 in Src/CrispyWaffle/Validations/PersonalDataValidation.cs

GitHub Actions / SonarCloud Analysis

Opening square brackets should not be preceded by a space. (https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1010.md)
return CalculateDocumentDigits(
document,
/// </summary>
private static readonly Dictionary<HashAlgorithmType, HashAlgorithm> _hashAlgorithms = new()
{
{ HashAlgorithmType.Md5, MD5.Create() },

Check warning on line 155 in Src/CrispyWaffle/Cryptography/Security.cs

GitHub Actions / Analyze (csharp)

_hashAlgorithms uses a broken cryptographic algorithm MD5 (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca5351)
{ HashAlgorithmType.Sha1, SHA1.Create() },

Check warning on line 156 in Src/CrispyWaffle/Cryptography/Security.cs

GitHub Actions / Analyze (csharp)

_hashAlgorithms uses a weak cryptographic algorithm SHA1 (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca5350)
{ HashAlgorithmType.Sha256, SHA256.Create() },
{ HashAlgorithmType.Sha384, SHA384.Create() },
{ HashAlgorithmType.Sha512, SHA512.Create() },
/// This class is specifically designed to work with <see cref="Adapters.JsonSerializerAdapter"/>.
/// It will not function correctly outside the context of this adapter.
/// </remarks>
public class NotNullObserver { }

Check warning on line 12 in Src/CrispyWaffle/Serialization/NotNullObserver.cs

GitHub Actions / Analyze (csharp)

Remove this empty class, write its code or make it an "interface". (https://rules.sonarsource.com/csharp/RSPEC-2094)
/// <value>
/// The event data of type <typeparamref name="TEvent"/>.
/// </value>
TEvent Event { get; }

Check warning on line 38 in Src/CrispyWaffle/Telemetry/ITelemetryEvent.cs

GitHub Actions / Analyze (csharp)

Rename virtual/interface member ITelemetryEvent<TEvent>.Event so that it no longer conflicts with the reserved language keyword 'Event'. Using a reserved keyword as the name of a virtual/interface member makes it harder for consumers in other languages to override/implement the member. (https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules/ca1716)
}