Cleanup source code

dncuug · Jul 13, 2024 · e257752 · e257752
1 parent e62fa92
commit e257752
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 49 deletions.
diff --git a/src/X.PagedList/IPagedList.cs b/src/X.PagedList/IPagedList.cs
@@ -8,12 +8,8 @@ namespace X.PagedList;
 /// Represents a subset of a collection of objects that can be individually accessed by index and containing
 /// metadata about the superset collection of objects this subset was created from.
 /// </summary>
-/// <remarks>
-/// Represents a subset of a collection of objects that can be individually accessed by index and containing
-/// metadata about the superset collection of objects this subset was created from.
-/// </remarks>
 /// <typeparam name="T">The type of object the collection should contain.</typeparam>
-/// <seealso cref="IEnumerable{T}"/>
+/// <seealso cref="IReadOnlyList{T}"/>
 [PublicAPI]
 public interface IPagedList<out T> : IPagedList, IReadOnlyList<T>
 {
@@ -29,101 +25,61 @@ public interface IPagedList<out T> : IPagedList, IReadOnlyList<T>
 /// Represents a subset of a collection of objects that can be individually accessed by index and containing
 /// metadata about the superset collection of objects this subset was created from.
 /// </summary>
-/// <remarks>
-/// Represents a subset of a collection of objects that can be individually accessed by index and containing
-/// metadata about the superset collection of objects this subset was created from.
-/// </remarks>
 public interface IPagedList
 {
     /// <summary>
     /// Total number of subsets within the superset.
     /// </summary>
-    /// <value>
-    /// Total number of subsets within the superset.
-    /// </value>
     int PageCount { get; }
 
     /// <summary>
     /// Total number of objects contained within the superset.
     /// </summary>
-    /// <value>
-    /// Total number of objects contained within the superset.
-    /// </value>
     int TotalItemCount { get; }
 
     /// <summary>
     /// One-based index of this subset within the superset, zero if the superset is empty.
     /// </summary>
-    /// <value>
-    /// One-based index of this subset within the superset, zero if the superset is empty.
-    /// </value>
     int PageNumber { get; }
 
     /// <summary>
     /// Maximum size any individual subset.
     /// </summary>
-    /// <value>
-    /// Maximum size any individual subset.
-    /// </value>
     int PageSize { get; }
 
     /// <summary>
     /// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
     /// is NOT the first subset within the superset.
     /// </summary>
-    /// <value>
-    /// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
-    /// is NOT the first subset within the superset.
-    /// </value>
     bool HasPreviousPage { get; }
 
     /// <summary>
     /// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
     /// is NOT the last subset within the superset.
     /// </summary>
-    /// <value>
-    /// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
-    /// is NOT the last subset within the superset.
-    /// </value>
     bool HasNextPage { get; }
 
     /// <summary>
     /// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
     /// is the first subset within the superset.
     /// </summary>
-    /// <value>
-    /// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
-    /// is the first subset within the superset.
-    /// </value>
     bool IsFirstPage { get; }
 
     /// <summary>
     /// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
     /// is the last subset within the superset.
     /// </summary>
-    /// <value>
-    /// Returns true if the superset is not empty and PageNumber is less than or equal to PageCount and this
-    /// is the last subset within the superset.
-    /// </value>
     bool IsLastPage { get; }
 
     /// <summary>
     /// One-based index of the first item in the paged subset, zero if the superset is empty or PageNumber
     /// is greater than PageCount.
     /// </summary>
-    /// <value>
-    /// One-based index of the first item in the paged subset, zero if the superset is empty or PageNumber
-    /// is greater than PageCount.
-    /// </value>
     int FirstItemOnPage { get; }
 
     /// <summary>
     /// One-based index of the last item in the paged subset, zero if the superset is empty or PageNumber
     /// is greater than PageCount.
     /// </summary>
-    /// <value>
-    /// One-based index of the last item in the paged subset, zero if the superset is empty or PageNumber
-    /// is greater than PageCount.
-    /// </value>
     int LastItemOnPage { get; }
 }
diff --git a/src/X.PagedList/PagedList.cs b/src/X.PagedList/PagedList.cs
@@ -9,10 +9,6 @@ namespace X.PagedList;
 /// Represents a subset of a collection of objects that can be individually accessed by index and containing
 /// metadata about the superset collection of objects this subset was created from.
 /// </summary>
-/// <remarks>
-/// Represents a subset of a collection of objects that can be individually accessed by index and containing
-/// metadata about the superset collection of objects this subset was created from.
-/// </remarks>
 /// <typeparam name="T">The type of object the collection should contain.</typeparam>
 /// <seealso cref="IPagedList{T}"/>
 /// <seealso cref="BasePagedList{T}"/>