Skip to content

Commit 186aff0

Browse files
committed
Added missing xmldoc
1 parent dc4e5b5 commit 186aff0

8 files changed

Lines changed: 85 additions & 0 deletions

File tree

src/FubarDev.FtpServer.Abstractions/Commands/FoundFeatureInfo.cs

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,48 +11,87 @@
1111

1212
namespace FubarDev.FtpServer.Commands
1313
{
14+
/// <summary>
15+
/// Found feature information.
16+
/// </summary>
1417
public class FoundFeatureInfo
1518
{
1619
private readonly IFtpCommandHandlerInformation _commandHandlerInfo;
1720
private readonly IFtpCommandHandlerExtensionInformation _extensionInfo;
1821
private readonly IAuthenticationMechanism _authenticationMechanism;
1922

23+
/// <summary>
24+
/// Initializes a new instance of the <see cref="FoundFeatureInfo"/> class.
25+
/// </summary>
26+
/// <param name="commandHandlerInfo">The FTP command handler information.</param>
27+
/// <param name="featureInfo">The feature information.</param>
2028
public FoundFeatureInfo([NotNull] IFtpCommandHandlerInformation commandHandlerInfo, [NotNull] IFeatureInfo featureInfo)
2129
{
2230
IsCommandHandler = true;
2331
_commandHandlerInfo = commandHandlerInfo;
2432
FeatureInfo = featureInfo;
2533
}
2634

35+
/// <summary>
36+
/// Initializes a new instance of the <see cref="FoundFeatureInfo"/> class.
37+
/// </summary>
38+
/// <param name="extensionInfo">The FTP command handler extension information.</param>
39+
/// <param name="featureInfo">The feature information.</param>
2740
public FoundFeatureInfo([NotNull] IFtpCommandHandlerExtensionInformation extensionInfo, [NotNull] IFeatureInfo featureInfo)
2841
{
2942
IsExtension = true;
3043
_extensionInfo = extensionInfo;
3144
FeatureInfo = featureInfo;
3245
}
3346

47+
/// <summary>
48+
/// Initializes a new instance of the <see cref="FoundFeatureInfo"/> class.
49+
/// </summary>
50+
/// <param name="authMechanism">The authentication mechanism.</param>
51+
/// <param name="featureInfo">The feature information.</param>
3452
public FoundFeatureInfo([NotNull] IAuthenticationMechanism authMechanism, [NotNull] IFeatureInfo featureInfo)
3553
{
3654
IsAuthenticationMechanism = true;
3755
_authenticationMechanism = authMechanism;
3856
FeatureInfo = featureInfo;
3957
}
4058

59+
/// <summary>
60+
/// Gets a value indicating whether <see cref="CommandHandlerInfo"/> is set.
61+
/// </summary>
4162
public bool IsCommandHandler { get; }
4263

64+
/// <summary>
65+
/// Gets the FTP command handler information.
66+
/// </summary>
4367
[NotNull]
4468
public IFtpCommandHandlerInformation CommandHandlerInfo => _commandHandlerInfo ?? throw new InvalidOperationException();
4569

70+
/// <summary>
71+
/// Gets a value indicating whether <see cref="ExtensionInfo"/> is set.
72+
/// </summary>
4673
public bool IsExtension { get; }
4774

75+
/// <summary>
76+
/// Gets the FTP command handler extension information.
77+
/// </summary>
4878
[NotNull]
4979
public IFtpCommandHandlerExtensionInformation ExtensionInfo => _extensionInfo ?? throw new InvalidOperationException();
5080

81+
/// <summary>
82+
/// Gets a value indicating whether <see cref="AuthenticationMechanism"/> is set.
83+
/// </summary>
5184
public bool IsAuthenticationMechanism { get; }
5285

86+
/// <summary>
87+
/// Gets the authentication mechanism.
88+
/// </summary>
5389
[NotNull]
5490
public IAuthenticationMechanism AuthenticationMechanism => _authenticationMechanism ?? throw new InvalidOperationException();
5591

92+
/// <summary>
93+
/// Gets the feature information.
94+
/// </summary>
5695
[NotNull]
5796
public IFeatureInfo FeatureInfo { get; }
5897
}

src/FubarDev.FtpServer.Abstractions/Commands/FtpCommandContext.cs

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,29 @@
66

77
namespace FubarDev.FtpServer.Commands
88
{
9+
/// <summary>
10+
/// The context in which the command gets executed.
11+
/// </summary>
912
public class FtpCommandContext
1013
{
14+
/// <summary>
15+
/// Initializes a new instance of the <see cref="FtpCommandContext"/> class.
16+
/// </summary>
17+
/// <param name="command">The FTP command.</param>
1118
public FtpCommandContext([NotNull] FtpCommand command)
1219
{
1320
Command = command;
1421
}
1522

23+
/// <summary>
24+
/// Gets the FTP command to be executed.
25+
/// </summary>
1626
[NotNull]
1727
public FtpCommand Command { get; }
1828

29+
/// <summary>
30+
/// Gets or sets the FTP connection.
31+
/// </summary>
1932
[CanBeNull]
2033
public IFtpConnection Connection { get; set; }
2134
}

src/FubarDev.FtpServer.Abstractions/Commands/IFtpCommandActivator.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,16 @@
66

77
namespace FubarDev.FtpServer.Commands
88
{
9+
/// <summary>
10+
/// Activator for an FTP command.
11+
/// </summary>
912
public interface IFtpCommandActivator
1013
{
14+
/// <summary>
15+
/// Gets information about the FTP command to be executed.
16+
/// </summary>
17+
/// <param name="context">The FTP command execution context.</param>
18+
/// <returns>Information about the FTP command to be executed.</returns>
1119
[CanBeNull]
1220
FtpCommandSelection Create([NotNull] FtpCommandContext context);
1321
}

src/FubarDev.FtpServer.Abstractions/Features/IConnectionFeature.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99

1010
namespace FubarDev.FtpServer.Features
1111
{
12+
/// <summary>
13+
/// Information about the current connection.
14+
/// </summary>
1215
public interface IConnectionFeature
1316
{
1417
/// <summary>

src/FubarDev.FtpServer.Abstractions/Features/ISecureConnectionFeature.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,9 @@
88

99
namespace FubarDev.FtpServer.Features
1010
{
11+
/// <summary>
12+
/// Information about low-level connection information.
13+
/// </summary>
1114
public interface ISecureConnectionFeature
1215
{
1316
/// <summary>

src/FubarDev.FtpServer.Abstractions/FtpFeatureFunctionAttribute.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,10 @@ public class FtpFeatureFunctionAttribute : Attribute, IFeatureInfo
2020
{
2121
private readonly string _functionName;
2222

23+
/// <summary>
24+
/// Initializes a new instance of the <see cref="FtpFeatureFunctionAttribute"/> class.
25+
/// </summary>
26+
/// <param name="functionName">The name of the function to be executed.</param>
2327
public FtpFeatureFunctionAttribute(string functionName)
2428
{
2529
_functionName = functionName;

src/FubarDev.FtpServer.Commands/CommandHandlers/LangCommandHandler.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ public class LangCommandHandler : FtpCommandHandler
3131
"^[a-z]{1,8}(-[A-Z]{1,8})*$",
3232
RegexOptions.Compiled | RegexOptions.IgnoreCase);
3333

34+
/// <summary>
35+
/// Build a string to be returned by the <c>FEAT</c> command handler.
36+
/// </summary>
37+
/// <param name="connection">The FTP connection.</param>
38+
/// <returns>The string to be returned.</returns>
39+
[NotNull]
3440
public static string CreateFeatureString([NotNull] IFtpConnection connection)
3541
{
3642
var catalogLoader = connection.ConnectionServices.GetRequiredService<IFtpCatalogLoader>();

src/FubarDev.FtpServer/Commands/DefaultFtpCommandActivator.cs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616

1717
namespace FubarDev.FtpServer.Commands
1818
{
19+
/// <summary>
20+
/// Default implementation of the <see cref="IFtpCommandActivator"/>.
21+
/// </summary>
1922
public class DefaultFtpCommandActivator : IFtpCommandActivator
2023
{
2124
[NotNull]
@@ -39,6 +42,12 @@ public class DefaultFtpCommandActivator : IFtpCommandActivator
3942
[NotNull]
4043
private readonly Dictionary<Type, PropertyInfo> _commandContextProperties = new Dictionary<Type, PropertyInfo>();
4144

45+
/// <summary>
46+
/// Initializes a new instance of the <see cref="DefaultFtpCommandActivator"/> class.
47+
/// </summary>
48+
/// <param name="serviceProvider">The service provider.</param>
49+
/// <param name="commandHandlerProvider">The provider for FTP command handlers.</param>
50+
/// <param name="commandHandlerExtensionProvider">The provider for FTP command handler extensions.</param>
4251
public DefaultFtpCommandActivator(
4352
[NotNull] IServiceProvider serviceProvider,
4453
[NotNull] IFtpCommandHandlerProvider commandHandlerProvider,

0 commit comments

Comments
 (0)