aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Controller/IServerApplicationHost.cs
diff options
context:
space:
mode:
authorMark Monteiro <marknr.monteiro@protonmail.com>2020-05-13 09:46:29 -0400
committerGitHub <noreply@github.com>2020-05-13 09:46:29 -0400
commit51cdb30741e5ad3d6ec9dc8a5383dc84d60f747a (patch)
tree9a49d465fc7face89bebd932a0ba17273ebaa5cd /MediaBrowser.Controller/IServerApplicationHost.cs
parenta10aec695671cd2e90ff67bd7bc6e18b450a8b3f (diff)
Apply documentation suggestions from code review
Co-authored-by: Vasily <JustAMan@users.noreply.github.com>
Diffstat (limited to 'MediaBrowser.Controller/IServerApplicationHost.cs')
-rw-r--r--MediaBrowser.Controller/IServerApplicationHost.cs3
1 files changed, 2 insertions, 1 deletions
diff --git a/MediaBrowser.Controller/IServerApplicationHost.cs b/MediaBrowser.Controller/IServerApplicationHost.cs
index 4f0ff1ee1..db330210a 100644
--- a/MediaBrowser.Controller/IServerApplicationHost.cs
+++ b/MediaBrowser.Controller/IServerApplicationHost.cs
@@ -72,7 +72,7 @@ namespace MediaBrowser.Controller
Task<string> GetLocalApiUrl(CancellationToken cancellationToken);
/// <summary>
- /// Gets a local (LAN) URL that can be used to access the API using the loop-back IP address (127.0.0.1)
+ /// Gets a localhost URL that can be used to access the API using the loop-back IP address (127.0.0.1)
/// over HTTP (not HTTPS).
/// </summary>
/// <returns>The API URL.</returns>
@@ -87,6 +87,7 @@ namespace MediaBrowser.Controller
/// <summary>
/// Gets a local (LAN) URL that can be used to access the API.
+ /// Note: if passing non-null scheme or port it is up to the caller to ensure they form the correct pair.
/// </summary>
/// <param name="hostname">The hostname to use in the URL.</param>
/// <param name="scheme">