fix: include XML documentation in package (#744)

Fixes #743

Author: fgreinacher

Directory.Build.props

@@ -5,15 +5,12 @@
     <Authors>Tatham Oddie &amp; friends</Authors>
     <SignAssembly Condition="'$(Configuration)' == 'Release'">True</SignAssembly>
     <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)StrongName.snk</AssemblyOriginatorKeyFile>
-    <PublishRepositoryUrl>true</PublishRepositoryUrl>
-    <IncludeSymbols>true</IncludeSymbols>
-    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
-    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <LangVersion>9.0</LangVersion>
     <PackageTags>testing</PackageTags>
     <PackageProjectUrl>https://github.com/System-IO-Abstractions/System.IO.Abstractions</PackageProjectUrl>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageReadmeFile>README.md</PackageReadmeFile>
+    <DefineConstants Condition="'$(TargetFramework)' != 'net461'">$(DefineConstants);FEATURE_FILE_SYSTEM_ACL_EXTENSIONS</DefineConstants>
     <DefineConstants Condition="'$(TargetFramework)' == 'net6.0' OR '$(TargetFramework)' == 'net5.0' OR '$(TargetFramework)' == 'netcoreapp3.1' OR '$(TargetFramework)' == 'netstandard2.1'">$(DefineConstants);FEATURE_ASYNC_FILE;FEATURE_ENUMERATION_OPTIONS;FEATURE_ADVANCED_PATH_OPERATIONS;FEATURE_PATH_JOIN_WITH_SPAN</DefineConstants>
     <DefineConstants Condition="'$(TargetFramework)' == 'net6.0' OR '$(TargetFramework)' == 'net5.0'">$(DefineConstants);FEATURE_FILE_MOVE_WITH_OVERWRITE</DefineConstants>
     <DefineConstants Condition="'$(TargetFramework)' == 'net6.0' OR '$(TargetFramework)' == 'net5.0'">$(DefineConstants);FEATURE_SUPPORTED_OS_ATTRIBUTE</DefineConstants>

benchmarks/System.IO.Abstractions.Benchmarks/FileSystemAbstractionBenchmarks.cs

@@ -22,7 +22,7 @@ public class FileSystemAbstractionBenchmarks
         #endregion
 
         #region CTOR's
-        public FileSystemAbstractionBenchmarks( )
+        public FileSystemAbstractionBenchmarks()
         {
             // Initialize file support
             _fileSupport = new FileSupport();

renovate.json

@@ -0,0 +1,6 @@
+{
+  extends: ["config:base"],
+  ignorePaths: [
+    // Clear the default list to enable Renovate for all files
+  ],
+}

renovate.json5

@@ -0,0 +1,11 @@
+<Project>
+  <Import Project="../Directory.Build.props" />
+  <PropertyGroup>
+    <PublishRepositoryUrl>true</PublishRepositoryUrl>
+    <IncludeSymbols>true</IncludeSymbols>
+    <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+    <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
+    <GenerateDocumentationFile >true</GenerateDocumentationFile>
+    <InheritDocEnabled>true</InheritDocEnabled>
+  </PropertyGroup>
+</Project>

src/Directory.Build.props

@@ -4,7 +4,7 @@ namespace System.IO.Abstractions.TestingHelpers
 {
     internal static class CommonExceptions
     {
-        private const int _fileLockHResult = unchecked((int) 0x80070020);
+        private const int _fileLockHResult = unchecked((int)0x80070020);
 
         public static FileNotFoundException FileNotFound(string path) =>
             new FileNotFoundException(
@@ -37,9 +37,9 @@ public static UnauthorizedAccessException AccessDenied(string path) =>
         public static Exception InvalidUseOfVolumeSeparator() =>
             new NotSupportedException(StringResources.Manager.GetString("THE_PATH_IS_NOT_OF_A_LEGAL_FORM"));
 
-        public static Exception PathIsNotOfALegalForm(string paramName) => 
+        public static Exception PathIsNotOfALegalForm(string paramName) =>
             new ArgumentException(
-                StringResources.Manager.GetString("THE_PATH_IS_NOT_OF_A_LEGAL_FORM"), 
+                StringResources.Manager.GetString("THE_PATH_IS_NOT_OF_A_LEGAL_FORM"),
                 paramName
             );
 
@@ -50,11 +50,11 @@ public static ArgumentNullException FilenameCannotBeNull(string paramName) =>
             );
 
         public static ArgumentException IllegalCharactersInPath(string paramName = null) =>
-            paramName != null 
+            paramName != null
                 ? new ArgumentException(StringResources.Manager.GetString("ILLEGAL_CHARACTERS_IN_PATH_EXCEPTION"), paramName)
                 : new ArgumentException(StringResources.Manager.GetString("ILLEGAL_CHARACTERS_IN_PATH_EXCEPTION"));
 
-        public static Exception InvalidUncPath(string paramName) => 
+        public static Exception InvalidUncPath(string paramName) =>
             new ArgumentException(@"The UNC path should be of the form \\server\share.", paramName);
 
         public static IOException ProcessCannotAccessFileInUse(string paramName = null) =>

src/System.IO.Abstractions.TestingHelpers/CommonExceptions.cs

@@ -6,7 +6,7 @@ namespace System.IO.Abstractions.TestingHelpers
     /// <summary>
     /// Provides access to the file system storage.
     /// </summary>
-    public interface IMockFileDataAccessor
+    public interface IMockFileDataAccessor : IFileSystem
     {
         /// <summary>
         /// Gets a file.
@@ -15,12 +15,24 @@ public interface IMockFileDataAccessor
         /// <returns>The file. <see langword="null"/> if the file does not exist.</returns>
         MockFileData GetFile(string path);
 
+        /// <summary>
+        /// </summary>
         void AddFile(string path, MockFileData mockFile);
+
+        /// <summary>
+        /// </summary>
         void AddDirectory(string path);
 
+        /// <summary>
+        /// </summary>
         void AddFileFromEmbeddedResource(string path, Assembly resourceAssembly, string embeddedResourcePath);
+
+        /// <summary>
+        /// </summary>
         void AddFilesFromEmbeddedNamespace(string path, Assembly resourceAssembly, string embeddedResourcePath);
 
+        /// <summary>
+        /// </summary>
         void MoveDirectory(string sourcePath, string destPath);
 
         /// <summary>
@@ -54,17 +66,20 @@ public interface IMockFileDataAccessor
         /// </summary>
         IEnumerable<string> AllDirectories { get; }
 
-        StringOperations StringOperations { get; }
+        /// <summary>
+        /// Gets a helper for string operations.
+        /// </summary>
 
-        IFile File { get; }
-        IDirectory Directory { get; }
-        IFileInfoFactory FileInfo {get; }
-        IPath Path { get; }
-        IDirectoryInfoFactory DirectoryInfo { get; }
-        IDriveInfoFactory DriveInfo { get; }
+        StringOperations StringOperations { get; }
 
+        /// <summary>
+        /// Gets a helper for verifying file system paths.
+        /// </summary>
         PathVerifier PathVerifier { get; }
 
+        /// <summary>
+        /// Gets a reference to the underlying file system. 
+        /// </summary>
         IFileSystem FileSystem { get; }
     }
 }