Fixing some comments errors to reduce CodeQL warnings (#13327)

This commit is contained in:
Lotte Pitcher
2022-11-30 15:01:36 +00:00
committed by GitHub
parent 02dcf98e3d
commit af4333b8e4
5 changed files with 15 additions and 8 deletions

View File

@@ -10,9 +10,8 @@ public abstract class BuilderCollectionBase<TItem> : IBuilderCollection<TItem>
{
private readonly LazyReadOnlyCollection<TItem> _items;
/// Initializes a new instance of the
/// <see cref="BuilderCollectionBase{TItem}" />
/// with items.
/// <summary>
/// Initializes a new instance of the <see cref="BuilderCollectionBase{TItem}" /> with items.
/// </summary>
/// <param name="items">The items.</param>
public BuilderCollectionBase(Func<IEnumerable<TItem>> items) => _items = new LazyReadOnlyCollection<TItem>(items);

View File

@@ -12,7 +12,7 @@ namespace Umbraco.Cms.Core.Configuration.Models;
/// Matches MailKit.Security.SecureSocketOptions and defined locally to avoid having to take
/// a dependency on this external library into Umbraco.Core.
/// </summary>
/// <seealso cref="http://www.mimekit.net/docs/html/T_MailKit_Security_SecureSocketOptions.htm" />
/// <seealso href="http://www.mimekit.net/docs/html/T_MailKit_Security_SecureSocketOptions.htm" />
public enum SecureSocketOptions
{
/// <summary>

View File

@@ -204,12 +204,20 @@ public static partial class UmbracoBuilderExtensions
=> builder.WithCollectionBuilder<DashboardCollectionBuilder>();
/// <summary>
/// Gets the partial view snippets collection builder.
/// </summary>
/// <param name="builder">The builder.</param>
public static PartialViewSnippetCollectionBuilder? PartialViewSnippets(this IUmbracoBuilder builder)
=> builder.WithCollectionBuilder<PartialViewSnippetCollectionBuilder>();
/// <summary>
/// Gets the partial view macro snippets collection builder.
/// </summary>
/// <param name="builder">The builder.</param>
public static PartialViewMacroSnippetCollectionBuilder? PartialViewMacroSnippets(this IUmbracoBuilder builder)
=> builder.WithCollectionBuilder<PartialViewMacroSnippetCollectionBuilder>();
/// <summary>
/// Gets the cache refreshers collection builder.
/// </summary>
/// <param name="builder">The builder.</param>

View File

@@ -9,7 +9,7 @@ namespace Umbraco.Cms.Core.Models.Blocks;
/// <summary>
/// Represents a layout item for the Block List editor.
/// </summary>
/// <seealso cref="Umbraco.Core.Models.Blocks.IBlockReference{Umbraco.Core.Models.PublishedContent.IPublishedElement}" />
/// <seealso cref="IBlockReference{IPublishedElement}" />
[DataContract(Name = "block", Namespace = "")]
public class BlockListItem : IBlockReference<IPublishedElement, IPublishedElement>
{
@@ -74,7 +74,7 @@ public class BlockListItem : IBlockReference<IPublishedElement, IPublishedElemen
/// Represents a layout item with a generic content type for the Block List editor.
/// </summary>
/// <typeparam name="T">The type of the content.</typeparam>
/// <seealso cref="Umbraco.Core.Models.Blocks.IBlockReference{Umbraco.Core.Models.PublishedContent.IPublishedElement}" />
/// <seealso cref="IBlockReference{IPublishedElement}" />
public class BlockListItem<T> : BlockListItem
where T : IPublishedElement
{
@@ -103,7 +103,7 @@ public class BlockListItem<T> : BlockListItem
/// </summary>
/// <typeparam name="TContent">The type of the content.</typeparam>
/// <typeparam name="TSettings">The type of the settings.</typeparam>
/// <seealso cref="Umbraco.Core.Models.Blocks.IBlockReference{Umbraco.Core.Models.PublishedContent.IPublishedElement}" />
/// <seealso cref="IBlockReference{IPublishedElement}" />
public class BlockListItem<TContent, TSettings> : BlockListItem<TContent>
where TContent : IPublishedElement
where TSettings : IPublishedElement

View File

@@ -6,7 +6,7 @@ namespace Umbraco.Cms.Core.Models;
/// Represents a range with a minimum and maximum value.
/// </summary>
/// <typeparam name="T">The type of the minimum and maximum values.</typeparam>
/// <seealso cref="System.IEquatable{Umbraco.Core.Models.Range{T}}" />
/// <seealso cref="IEquatable{Range{T}}" />
public class Range<T> : IEquatable<Range<T>>
where T : IComparable<T>
{