Skip to content

Commit

Permalink
RavenDB-23099 Fix XML comments for DeleteRevisionsOperation
Browse files Browse the repository at this point in the history
  • Loading branch information
Danielle9897 committed Nov 3, 2024
1 parent dfc4fd1 commit 2573baa
Showing 1 changed file with 16 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ public sealed class DeleteRevisionsOperation : IMaintenanceOperation<DeleteRevis
/// This operation allows deletion of revisions.
/// </summary>
/// <remarks>
/// This is an <c>Admin</c> to operation.
/// This is an <c>Admin</c> operation.
/// </remarks>

/// <param name="documentIds">
Expand All @@ -33,8 +33,8 @@ public sealed class DeleteRevisionsOperation : IMaintenanceOperation<DeleteRevis
/// </exception>

/// <param name="removeForceCreatedRevisions">
/// Indicates whether to include force-created revisions in the deletion
/// (Can find more info <see href="https://ravendb.net/docs/article-page/6.0/csharp/document-extensions/revisions/overview#force-revision-creation">here</see>).
/// Indicates whether to include force-created revisions in the deletion.
/// (Can find more info <see href="https://ravendb.net/docs/article-page/latest/csharp/document-extensions/revisions/overview#force-revision-creation">here</see>).
/// Default is <c>false</c>.
/// </param>

Expand All @@ -54,7 +54,7 @@ public DeleteRevisionsOperation(List<string> documentIds, bool removeForceCreate
/// This operation allows deletion of revisions.
/// </summary>
/// <remarks>
/// This is an <c>Admin</c> to operation.
/// This is an <c>Admin</c> operation.
/// </remarks>

/// <param name="documentId">
Expand All @@ -65,8 +65,8 @@ public DeleteRevisionsOperation(List<string> documentIds, bool removeForceCreate
/// </exception>

/// <param name="removeForceCreatedRevisions">
/// Indicates whether to include force-created revisions in the deletion
/// (Can find more info <see href="https://ravendb.net/docs/article-page/6.0/csharp/document-extensions/revisions/overview#force-revision-creation">here</see>).
/// Indicates whether to include force-created revisions in the deletion.
/// (Can find more info <see href="https://ravendb.net/docs/article-page/latest/csharp/document-extensions/revisions/overview#force-revision-creation">here</see>).
/// Default is <c>false</c>.
/// </param>

Expand All @@ -86,7 +86,7 @@ public DeleteRevisionsOperation(string documentId, bool removeForceCreatedRevisi
/// This operation allows deletion of revisions.
/// </summary>
/// <remarks>
/// This is an <c>Admin</c> to operation.
/// This is an <c>Admin</c> operation.
/// </remarks>

/// <param name="documentIds">
Expand All @@ -108,7 +108,7 @@ public DeleteRevisionsOperation(string documentId, bool removeForceCreatedRevisi

/// <param name="removeForceCreatedRevisions">
/// Indicates whether to include force-created revisions in the deletion.
/// (Can find more info <see href="https://ravendb.net/docs/article-page/6.0/csharp/document-extensions/revisions/overview#force-revision-creation">here</see>).
/// (Can find more info <see href="https://ravendb.net/docs/article-page/latest/csharp/document-extensions/revisions/overview#force-revision-creation">here</see>).
/// Default is <c>false</c>.
/// </param>

Expand All @@ -130,7 +130,7 @@ public DeleteRevisionsOperation(List<string> documentIds, DateTime? from, DateTi
/// This operation allows deletion of revisions.
/// </summary>
/// <remarks>
/// This is an <c>Admin</c> to operation.
/// This is an <c>Admin</c> operation.
/// </remarks>

/// <param name="documentId">
Expand All @@ -151,8 +151,8 @@ public DeleteRevisionsOperation(List<string> documentIds, DateTime? from, DateTi
/// </exception>

/// <param name="removeForceCreatedRevisions">
/// Indicates whether to include force-created revisions in the deletion
/// (Can find more info <see href="https://ravendb.net/docs/article-page/6.0/csharp/document-extensions/revisions/overview#force-revision-creation">here</see>).
/// Indicates whether to include force-created revisions in the deletion.
/// (Can find more info <see href="https://ravendb.net/docs/article-page/latest/csharp/document-extensions/revisions/overview#force-revision-creation">here</see>).
/// Default is <c>false</c>.
/// </param>

Expand All @@ -174,7 +174,7 @@ public DeleteRevisionsOperation(string documentId, DateTime? from, DateTime? to,
/// This operation allows deletion of revisions.
/// </summary>
/// <remarks>
/// This is an <c>Admin</c> to operation.
/// This is an <c>Admin</c> operation.
/// </remarks>

/// <param name="documentId">
Expand All @@ -185,15 +185,15 @@ public DeleteRevisionsOperation(string documentId, DateTime? from, DateTime? to,
/// </exception>

/// <param name="revisionsChangeVectors">
/// A list of change vectors corresponding to the revisions that the user wishes to delete.
/// A list of change vectors corresponding to the revisions you want to delete.
/// </param>
/// <exception cref="ArgumentNullException">
/// Thrown when the <paramref name="revisionsChangeVectors"/> parameter is null or empty.
/// </exception>

/// <param name="removeForceCreatedRevisions">
/// Indicates whether to include force-created revisions in the deletion
/// (Can find more info <see href="https://ravendb.net/docs/article-page/6.0/csharp/document-extensions/revisions/overview#force-revision-creation">here</see>).
/// Indicates whether to include force-created revisions in the deletion.
/// (Can find more info <see href="https://ravendb.net/docs/article-page/latest/csharp/document-extensions/revisions/overview#force-revision-creation">here</see>).
/// Default is <c>false</c>.
/// </param>

Expand Down Expand Up @@ -241,7 +241,7 @@ internal void Validate()
if (RevisionsChangeVectors.IsNullOrEmpty())
{
if (From.HasValue && To.HasValue && From >= To)
throw new ArgumentException($"{nameof(From)}, {nameof(To)}", "'After' must be greater then 'Before'.");
throw new ArgumentException($"{nameof(From)}, {nameof(To)}", "'To' must be greater then 'From'.");
}
else
{
Expand Down

0 comments on commit 2573baa

Please sign in to comment.