Browse Source

Added a comment for RestListener.Init

Kenric Nugteren 2 years ago
parent
commit
87f710d00c
1 changed files with 4 additions and 0 deletions
  1. 4 0
      InABox.Server/Rest/RestListener.cs

+ 4 - 0
InABox.Server/Rest/RestListener.cs

@@ -551,6 +551,10 @@ namespace InABox.API
             certificate = null;
         }
 
+        /// <summary>
+        /// Initialise rest listener, and set up web socket port if non-zero.
+        /// </summary>
+        /// <param name="webSocketPort">The web-socket port to use, or 0 for no websocket.</param>
         public static void Init(int webSocketPort)
         {
             if(webSocketPort != 0)