Index: Core/Common/src/Core.Common.IO/DirectoryHelper.cs
===================================================================
diff -u -rd70be6f1085d61194caa344db80ba4938fd08218 -rce9add3e802e5142dca57aab8e7a0399be614db6
--- Core/Common/src/Core.Common.IO/DirectoryHelper.cs (.../DirectoryHelper.cs) (revision d70be6f1085d61194caa344db80ba4938fd08218)
+++ Core/Common/src/Core.Common.IO/DirectoryHelper.cs (.../DirectoryHelper.cs) (revision ce9add3e802e5142dca57aab8e7a0399be614db6)
@@ -31,29 +31,30 @@
public static class DirectoryHelper
{
///
- /// Tries to delete the provided directory.
+ /// Tries to delete the directory specified by .
///
/// The path of the directory to delete.
- /// The number of retries in case of an .
- /// This helper method is a solution to latency issues caused by temporary file locks.
+ /// The number of retries in case an occurs.
+ /// This helper method is a solution to latency issues caused by file locks, which normally cause an
+ /// . The file locks at stake will be released as soon as the application becomes idle,
+ /// which explains retrying the delete action for times.
/// Thrown when:
///
- /// - a file with the same name and location specified by path exists;
- /// - the directory specified by path is read-only;
+ /// - a file with the same name and location exists;
+ /// - the directory is read-only;
/// - the directory is the application's current working directory;
- /// - the directory is the application's current working directory;
/// - the directory contains a read-only file;
/// - the directory is being used by another process.
///
///
- /// Thrown when the caller does not have the required permission.
- /// Thrown when path is a zero-length string, contains only white space, or contains one or more invalid characters.
- /// Thrown when path is null.
- /// Thrown when the specified path exceeds the system-defined maximum length.
- /// Thrown when:
+ /// Thrown when the caller does not have the required permissions.
+ /// Thrown when the specified path is a zero-length string, contains only white spaces, or contains one or more invalid characters.
+ /// Thrown when is null.
+ /// Thrown when the specified path exceeds the system defined maximum length.
+ /// Thrown when the specified path:
///
- /// - path does not exist or could not be found;
- /// - the specified path is invalid (for example, it is on an unmapped drive).
+ /// - does not exist or could not be found;
+ /// - is invalid (for example, it is on an unmapped drive).
///
///
public static void TryDelete(string path, int numberOfRetries = 5)