Documentation fixes

FubarDevelopment · May 1, 2019 · 9d345e6 · 9d345e6
1 parent 12648ab
commit 9d345e6
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 4 deletions.
diff --git a/src/FubarDev.FtpServer.Abstractions/ListFormatters/Facts/PermissionsFact.cs b/src/FubarDev.FtpServer.Abstractions/ListFormatters/Facts/PermissionsFact.cs
@@ -20,7 +20,7 @@ public class PermissionsFact : IFact
         /// Initializes a new instance of the <see cref="PermissionsFact"/> class.
         /// </summary>
         /// <param name="user">The current user.</param>
-        /// <param name="fileSystem">The current file system of the given <see cref="entry"/>.</param>
+        /// <param name="fileSystem">The current file system of the given <paramref name="entry"/>.</param>
         /// <param name="dir">The current directory.</param>
         /// <param name="entry">The file to create the permissions for.</param>
         public PermissionsFact([NotNull] IFtpUser user, [NotNull] IUnixFileSystem fileSystem, [NotNull] IUnixDirectoryEntry dir, [NotNull] IUnixFileEntry entry)

diff --git a/src/FubarDev.FtpServer/GnuSslStream/GnuSslStream.cs b/src/FubarDev.FtpServer/GnuSslStream/GnuSslStream.cs
@@ -1,4 +1,4 @@
-// This file isn't generated, but this comment is necessary to exclude it from StyleCop analysis.
+// This file isn't generated, but this comment is necessary to exclude it from StyleCop analysis.
 // <auto-generated/>
 
 #if USE_GNU_SSL_STREAM
@@ -26,20 +26,52 @@
 
 namespace System.Net.Security
 {
+    /// <summary>
+    /// An SslStream implementation that gracefully terminates the SSL stream.
+    /// </summary>
+    /// <remarks>
+    /// This implementation works only(!) on Windows and is used to fix a misbehaviour
+    /// in combination with applications using GnuTLS.
+    /// </remarks>
     public class GnuSslStream : SslStream
     {
+        /// <summary>
+        /// Initializes a new instance of the <see cref="GnuSslStream"/> class.
+        /// </summary>
+        /// <param name="innerStream">The inner (network) stream.</param>
         public GnuSslStream(Stream innerStream)
             : base(innerStream)
         {
         }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="GnuSslStream"/> class.
+        /// </summary>
+        /// <param name="innerStream">The inner (network) stream.</param>
+        /// <param name="leaveInnerStreamOpen">Leave the inner stream open.</param>
         public GnuSslStream(Stream innerStream, bool leaveInnerStreamOpen)
             : base(innerStream, leaveInnerStreamOpen)
         {
         }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="GnuSslStream"/> class.
+        /// </summary>
+        /// <param name="innerStream">The inner (network) stream.</param>
+        /// <param name="leaveInnerStreamOpen">Leave the inner stream open.</param>
+        /// <param name="userCertificateValidationCallback">A callback allowing validation of user certificates.</param>
         public GnuSslStream(Stream innerStream, bool leaveInnerStreamOpen, RemoteCertificateValidationCallback userCertificateValidationCallback)
             : base(innerStream, leaveInnerStreamOpen, userCertificateValidationCallback)
         {
         }
+
+        /// <summary>
+        /// Initializes a new instance of the <see cref="GnuSslStream"/> class.
+        /// </summary>
+        /// <param name="innerStream">The inner (network) stream.</param>
+        /// <param name="leaveInnerStreamOpen">Leave the inner stream open.</param>
+        /// <param name="userCertificateValidationCallback">A callback allowing validation of user certificates.</param>
+        /// <param name="userCertificateSelectionCallback">A callback for the user certificate selection.</param>
         public GnuSslStream(Stream innerStream, bool leaveInnerStreamOpen, RemoteCertificateValidationCallback userCertificateValidationCallback, LocalCertificateSelectionCallback userCertificateSelectionCallback)
             : base(innerStream, leaveInnerStreamOpen, userCertificateValidationCallback, userCertificateSelectionCallback)
         {
@@ -51,6 +83,8 @@ public GnuSslStream(Stream innerStream, bool leaveInnerStreamOpen, RemoteCertifi
         {
         }
 #endif
+
+        /// <inheritdoc />
         public override void Close()
         {
             //MARK: SslStream in Mono works correctly.

diff --git a/src/FubarDev.FtpServer/GnuSslStream/ReflectUtil.cs b/src/FubarDev.FtpServer/GnuSslStream/ReflectUtil.cs
@@ -1,4 +1,4 @@
-// This file isn't generated, but this comment is necessary to exclude it from StyleCop analysis.
+// This file isn't generated, but this comment is necessary to exclude it from StyleCop analysis.
 // <auto-generated/>
 
 #if USE_GNU_SSL_STREAM
@@ -9,7 +9,7 @@
 
 namespace System.Net.Security
 {
-    public static class ReflectUtil
+    internal static class ReflectUtil
     {
         public static object GetField(object obj, string fieldName)
         {