Skip to content

Commit e6413c6

Browse files
authored
docs: fix XML documentation warnings (#1194)
Fix warnings due to incorrect XML documentation in "TestableIO.System.IO.Abstractions.Wrappers"
1 parent 15d0547 commit e6413c6

21 files changed

+94
-54
lines changed

src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryBase.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
using System.Collections.Generic;
2-
using System.Runtime.Versioning;
3-
using System.Security.AccessControl;
42

53
namespace System.IO.Abstractions
64
{
@@ -10,7 +8,9 @@ namespace System.IO.Abstractions
108
#endif
119
public abstract class DirectoryBase : IDirectory
1210
{
13-
/// <inheritdoc />
11+
/// <summary>
12+
/// Base class for calling static methods of <see cref="Directory"/>
13+
/// </summary>
1414
protected DirectoryBase(IFileSystem fileSystem)
1515
{
1616
FileSystem = fileSystem;

src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryInfoBase.cs

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
using System.Collections.Generic;
2-
using System.Security.AccessControl;
32

43
namespace System.IO.Abstractions
54
{
@@ -9,7 +8,9 @@ namespace System.IO.Abstractions
98
#endif
109
public abstract class DirectoryInfoBase : FileSystemInfoBase, IDirectoryInfo
1110
{
12-
/// <inheritdoc />
11+
/// <summary>
12+
/// Base class for calling methods of <see cref="DirectoryInfo"/>
13+
/// </summary>
1314
protected DirectoryInfoBase(IFileSystem fileSystem) : base(fileSystem)
1415
{
1516
}
@@ -120,7 +121,9 @@ internal DirectoryInfoBase() { }
120121
/// <inheritdoc cref="IDirectoryInfo.Root"/>
121122
public abstract IDirectoryInfo Root { get; }
122123

123-
/// <inheritdoc />
124+
/// <summary>
125+
/// Implicitly converts a <see cref="DirectoryInfo"/> to a <see cref="DirectoryInfoBase"/>.
126+
/// </summary>
124127
public static implicit operator DirectoryInfoBase(DirectoryInfo directoryInfo)
125128
{
126129
if (directoryInfo == null)

src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryInfoFactory.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ internal class DirectoryInfoFactory : IDirectoryInfoFactory
77
{
88
private readonly IFileSystem fileSystem;
99

10-
/// <inheritdoc />
10+
/// <summary>
11+
/// Base factory class for creating a <see cref="IDirectoryInfo"/>
12+
/// </summary>
1113
public DirectoryInfoFactory(IFileSystem fileSystem)
1214
{
1315
this.fileSystem = fileSystem;

src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryInfoWrapper.cs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
using System.Collections.Generic;
2-
using System.IO.Pipes;
32
using System.Linq;
43
using System.Runtime.Versioning;
54
using System.Security.AccessControl;
65

76
namespace System.IO.Abstractions
87
{
9-
/// <inheritdoc />
8+
/// <inheritdoc cref="DirectoryInfoBase" />
109
#if FEATURE_SERIALIZABLE
1110
[Serializable]
1211
#endif
1312
public class DirectoryInfoWrapper : DirectoryInfoBase, IFileSystemAclSupport
1413
{
1514
private readonly DirectoryInfo instance;
1615

17-
/// <inheritdoc />
16+
/// <summary>
17+
/// Wrapper class for calling methods of <see cref="DirectoryInfo"/>
18+
/// </summary>
1819
public DirectoryInfoWrapper(IFileSystem fileSystem, DirectoryInfo instance) : base(fileSystem)
1920
{
2021
this.instance = instance ?? throw new ArgumentNullException(nameof(instance));

src/TestableIO.System.IO.Abstractions.Wrappers/DirectoryWrapper.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace System.IO.Abstractions
55
{
6-
/// <inheritdoc />
6+
/// <inheritdoc cref="DirectoryBase" />
77
#if FEATURE_SERIALIZABLE
88
[Serializable]
99
#endif

src/TestableIO.System.IO.Abstractions.Wrappers/DriveInfoBase.cs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@
66
#endif
77
public abstract class DriveInfoBase : IDriveInfo
88
{
9-
/// <inheritdoc />
9+
/// <summary>
10+
/// Base class for calling methods of <see cref="DriveInfo"/>
11+
/// </summary>
1012
protected DriveInfoBase(IFileSystem fileSystem)
1113
{
1214
FileSystem = fileSystem ?? throw new ArgumentNullException(nameof(fileSystem));
@@ -48,9 +50,8 @@ internal DriveInfoBase() { }
4850
public abstract string VolumeLabel { get; set; }
4951

5052
/// <summary>
51-
/// Converts a <see cref="DriveInfo"/> into a <see cref="DriveInfoBase"/>.
53+
/// Implicitly converts a <see cref="DriveInfo"/> to a <see cref="DriveInfoBase"/>.
5254
/// </summary>
53-
/// <param name="driveInfo">The drive info to be converted.</param>
5455
public static implicit operator DriveInfoBase(DriveInfo driveInfo)
5556
{
5657
if (driveInfo == null)

src/TestableIO.System.IO.Abstractions.Wrappers/DriveInfoFactory.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ internal class DriveInfoFactory : IDriveInfoFactory
77
{
88
private readonly IFileSystem fileSystem;
99

10+
/// <summary>
11+
/// Base factory class for creating a <see cref="IDriveInfo"/>
12+
/// </summary>
1013
public DriveInfoFactory(IFileSystem fileSystem)
1114
{
1215
this.fileSystem = fileSystem;

src/TestableIO.System.IO.Abstractions.Wrappers/FileBase.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,9 @@ namespace System.IO.Abstractions
1010
#endif
1111
public abstract partial class FileBase : IFile
1212
{
13-
///
13+
/// <summary>
14+
/// Base class for calling static methods of <see cref="File"/>
15+
/// </summary>
1416
protected FileBase(IFileSystem fileSystem)
1517
{
1618
FileSystem = fileSystem;

src/TestableIO.System.IO.Abstractions.Wrappers/FileInfoBase.cs

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
1-
using System.Security.AccessControl;
2-
3-
namespace System.IO.Abstractions
1+
namespace System.IO.Abstractions
42
{
53
/// <inheritdoc cref="FileInfo"/>
64
#if FEATURE_SERIALIZABLE
75
[Serializable]
86
#endif
97
public abstract class FileInfoBase : FileSystemInfoBase, IFileInfo
108
{
11-
/// <inheritdoc />
9+
/// <summary>
10+
/// Base class for calling methods of <see cref="FileInfo"/>
11+
/// </summary>
1212
protected FileInfoBase(IFileSystem fileSystem) : base(fileSystem)
1313
{
1414
}
@@ -86,7 +86,9 @@ internal FileInfoBase() { }
8686
/// <inheritdoc cref="IFileInfo.Length"/>
8787
public abstract long Length { get; }
8888

89-
/// <inheritdoc />
89+
/// <summary>
90+
/// Implicitly converts a <see cref="FileInfo"/> to a <see cref="FileInfoBase"/>.
91+
/// </summary>
9092
public static implicit operator FileInfoBase(FileInfo fileInfo)
9193
{
9294
if (fileInfo == null)

src/TestableIO.System.IO.Abstractions.Wrappers/FileInfoFactory.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@ internal class FileInfoFactory : IFileInfoFactory
77
{
88
private readonly IFileSystem fileSystem;
99

10-
/// <inheritdoc />
10+
/// <summary>
11+
/// Base factory class for creating a <see cref="IFileInfo"/>
12+
/// </summary>
1113
public FileInfoFactory(IFileSystem fileSystem)
1214
{
1315
this.fileSystem = fileSystem;

0 commit comments

Comments
 (0)