Merge branch 'release/v1.0.1'

Author: chriswalpen

Abstract.FileSystem.sln

@@ -15,6 +15,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 	ProjectSection(SolutionItems) = preProject
 		src\Abstract.FileSystem.snk = src\Abstract.FileSystem.snk
 		appveyor.yml = appveyor.yml
+		CHANGELOG.md = CHANGELOG.md
 		LICENSE = LICENSE
 		README.md = README.md
 		testenvironments.json = testenvironments.json

CHANGELOG.md

@@ -0,0 +1,15 @@
+# Abstract.FileSystem
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## v1.0.1
+### Fixed
+- Fixed XML Documentation
+
+## v1.0.0
+### Added
+- Abstraction for System.IO.File
+- Abstraction for System.IO.Directory
+- Abstraction for System.IO.Path

build/Build.cs

@@ -32,7 +32,7 @@ class Build : NukeBuild
     [GitRepository] readonly GitRepository GitRepository;
 
     [Parameter("Version to be injected in the Build")]
-    public string Version { get; set; } = $"1.0.0";
+    public string Version { get; set; } = $"1.0.1";
 
     [Parameter("The Buildnumber provided by the CI")]
     public int BuildNo = 1;

src/Abstract.FileSystem/DirectoryService.cs

@@ -4,6 +4,9 @@
 
 namespace Abstract.FileSystem
 {
+    /// <summary>
+    /// Wrapper fpr System.IO.Directory
+    /// </summary>
     public class DirectoryService : IDirectoryService
     {
         /// <summary>

src/Abstract.FileSystem/File.cs

@@ -54,7 +54,7 @@ public static void AppendAllLines(string path, IEnumerable<string> contents)
             _fileService.AppendAllLines(path, contents);
         }
 
-        // <summary>
+        /// <summary>
         /// Appends lines to a file by using a specified encoding, and then closes the file.
         /// If the specified file does not exist, this method creates a file, writes the
         /// specified lines to the file, and then closes the file.
@@ -276,7 +276,6 @@ public static DateTime GetLastWriteTimeUtc(string path)
         }
 
         /// <summary>
-        /// /// <summary>
         /// Moves a specified file to a new location, providing the option to specify a new file name.
         /// </summary>
         /// <param name="sourceFileName">The name of the file to move. Can include a relative or absolute path.</param>
@@ -287,13 +286,12 @@ public static void Move(string sourceFileName, string destFileName)
         }
 
         /// <summary>
-        /// Opens a System.IO.FileStream on the specified path, having the specified mode with read, write, or read/write access and the specified sharing option.
+        /// Opens a System.IO.FileStream on the specified path, with the specified mode and access.
         /// </summary>
         /// <param name="path">The file to open.</param>
         /// <param name="mode">A System.IO.FileMode value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten.</param>
         /// <param name="access">A System.IO.FileAccess value that specifies the operations that can be performed on the file.</param>
-        /// <param name="share">A System.IO.FileShare value specifying the type of access other threads have to the file.</param>
-        /// <returns>A System.IO.FileStream on the specified path, having the specified mode with read, write, or read/write access and the specified sharing option.</returns>
+        /// <returns>An unshared System.IO.FileStream that provides access to the specified file, with the specified mode and access.</returns>
         public static FileStream Open(string path, FileMode mode, FileAccess access)
         {
             return _fileService.Open(path, mode, access);
@@ -453,7 +451,7 @@ public static void Replace(string sourceFileName, string destinationFileName, st
         /// Sets the specified System.IO.FileAttributes of the file on the specified path.
         /// </summary>
         /// <param name="path">The path to the file.</param>
-        /// <param name="fileAttributes"A bitwise combination of the enumeration values.></param>
+        /// <param name="fileAttributes">A bitwise combination of the enumeration values.</param>
         public static void SetAttributes(string path, FileAttributes fileAttributes)
         {
             _fileService.SetAttributes(path, fileAttributes);

src/Abstract.FileSystem/FileService.cs

@@ -244,7 +244,6 @@ public DateTime GetLastWriteTimeUtc(string path)
         }
 
         /// <summary>
-        /// /// <summary>
         /// Moves a specified file to a new location, providing the option to specify a new file name.
         /// </summary>
         /// <param name="sourceFileName">The name of the file to move. Can include a relative or absolute path.</param>
@@ -255,13 +254,12 @@ public void Move(string sourceFileName, string destFileName)
         }
 
         /// <summary>
-        /// Opens a System.IO.FileStream on the specified path, having the specified mode with read, write, or read/write access and the specified sharing option.
+        /// Opens a System.IO.FileStream on the specified path, with the specified mode and access.
         /// </summary>
         /// <param name="path">The file to open.</param>
         /// <param name="mode">A System.IO.FileMode value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten.</param>
         /// <param name="access">A System.IO.FileAccess value that specifies the operations that can be performed on the file.</param>
-        /// <param name="share">A System.IO.FileShare value specifying the type of access other threads have to the file.</param>
-        /// <returns>A System.IO.FileStream on the specified path, having the specified mode with read, write, or read/write access and the specified sharing option.</returns>
+        /// <returns>An unshared System.IO.FileStream that provides access to the specified file, with the specified mode and access.</returns>
         public FileStream Open(string path, FileMode mode, FileAccess access)
         {
             return System.IO.File.Open(path, mode, access);
@@ -421,7 +419,7 @@ public void Replace(string sourceFileName, string destinationFileName, string de
         /// Sets the specified System.IO.FileAttributes of the file on the specified path.
         /// </summary>
         /// <param name="path">The path to the file.</param>
-        /// <param name="fileAttributes"A bitwise combination of the enumeration values.></param>
+        /// <param name="fileAttributes">A bitwise combination of the enumeration values.></param>
         public void SetAttributes(string path, FileAttributes fileAttributes)
         {
             System.IO.File.SetAttributes(path, fileAttributes);

src/Abstract.FileSystem/IFileService.cs

@@ -183,12 +183,12 @@ public interface IFileService
         /// <param name="sourceFileName">The name of the file to move. Can include a relative or absolute path.</param>
         /// <param name="destFileName">The new path and name for the file.</param>
         void Move(string sourceFileName, string destFileName);
-        
+
         /// <summary>
         /// Opens a System.IO.FileStream on the specified path, with the specified mode and access.
         /// </summary>
         /// <param name="path">The file to open.</param>
-        /// <param name="mode">A System.IO.FileMode value that specifies whether a file is created if one doesnot exist, and determines whether the contents of existing files are retained or overwritten.</param>
+        /// <param name="mode">A System.IO.FileMode value that specifies whether a file is created if one does not exist, and determines whether the contents of existing files are retained or overwritten.</param>
         /// <param name="access">A System.IO.FileAccess value that specifies the operations that can be performed on the file.</param>
         /// <returns>An unshared System.IO.FileStream that provides access to the specified file, with the specified mode and access.</returns>
         FileStream Open(string path, FileMode mode, FileAccess access);
@@ -305,7 +305,7 @@ public interface IFileService
         /// Sets the specified System.IO.FileAttributes of the file on the specified path.
         /// </summary>
         /// <param name="path">The path to the file.</param>
-        /// <param name="fileAttributes"A bitwise combination of the enumeration values.></param>
+        /// <param name="fileAttributes">A bitwise combination of the enumeration values.></param>
         void SetAttributes(string path, FileAttributes fileAttributes);
 
         /// <summary>

src/Abstract.FileSystem/Path.cs

@@ -72,7 +72,7 @@ public static void Setup(Func<IPathService> service)
         /// null or an empty string (""), the path information is returned unmodified. If
         /// extension is null, the returned string contains the specified path with its extension
         /// removed. If path has no extension, and extension is not null, the returned path
-        /// string contains extension appended to the end of path.
+        /// string contains extension appended to the end of path.</returns>
         public static string ChangeExtension(string path, string extension)
         {
             return _pathService.ChangeExtension(path, extension);

src/Abstract.FileSystem/PathService.cs

@@ -14,7 +14,7 @@ public class PathService : IPathService
         /// null or an empty string (""), the path information is returned unmodified. If
         /// extension is null, the returned string contains the specified path with its extension
         /// removed. If path has no extension, and extension is not null, the returned path
-        /// string contains extension appended to the end of path.
+        /// string contains extension appended to the end of path.</returns>
         public string ChangeExtension(string path, string extension)
         {
             return System.IO.Path.ChangeExtension(path, extension);

src/Abstract.FileSystem/SystemPath.cs

@@ -5,6 +5,9 @@
 
 namespace Abstract.FileSystem
 {
+    /// <summary>
+    /// 
+    /// </summary>
     [Serializable]
     [DebuggerDisplay("{" + nameof(_path) + "}")]
     public class SystemPath