From 003238ef5e5151c43738fedcc90f83fd5064580a Mon Sep 17 00:00:00 2001
From: Bond_009 <bond.009@outlook.com>
Date: Sun, 11 Aug 2019 15:11:53 +0200
Subject: Update deps + document startup project

* Fixed the release build
* Documented all public/internal members of Jellyfin.Server
* Enable TreatWarningsAsErrors for debug builds for Jellyfin.Server

This will ensure that any new public/internal members of Jellyfin.Server
are documented
---
 Jellyfin.Server/StartupOptions.cs | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

(limited to 'Jellyfin.Server/StartupOptions.cs')

diff --git a/Jellyfin.Server/StartupOptions.cs b/Jellyfin.Server/StartupOptions.cs
index 8296d414ef..bb0adaf630 100644
--- a/Jellyfin.Server/StartupOptions.cs
+++ b/Jellyfin.Server/StartupOptions.cs
@@ -8,36 +8,62 @@ namespace Jellyfin.Server
     /// </summary>
     public class StartupOptions : IStartupOptions
     {
+        /// <summary>
+        /// Gets or sets the path to the data directory.
+        /// </summary>
+        /// <value>The path to the data directory.</value>
         [Option('d', "datadir", Required = false, HelpText = "Path to use for the data folder (database files, etc.).")]
         public string DataDir { get; set; }
 
+        /// <summary>
+        /// Gets or sets the path to the web directory.
+        /// </summary>
+        /// <value>The path to the web directory.</value>
         [Option('w', "webdir", Required = false, HelpText = "Path to the Jellyfin web UI resources.")]
         public string WebDir { get; set; }
 
+        /// <summary>
+        /// Gets or sets the path to the cache directory.
+        /// </summary>
+        /// <value>The path to the cache directory.</value>
         [Option('C', "cachedir", Required = false, HelpText = "Path to use for caching.")]
         public string CacheDir { get; set; }
 
+        /// <summary>
+        /// Gets or sets the path to the config directory.
+        /// </summary>
+        /// <value>The path to the config directory.</value>
         [Option('c', "configdir", Required = false, HelpText = "Path to use for configuration data (user settings and pictures).")]
         public string ConfigDir { get; set; }
 
+        /// <summary>
+        /// Gets or sets the path to the log directory.
+        /// </summary>
+        /// <value>The path to the log directory.</value>
         [Option('l', "logdir", Required = false, HelpText = "Path to use for writing log files.")]
         public string LogDir { get; set; }
 
+        /// <inheritdoc />
         [Option("ffmpeg", Required = false, HelpText = "Path to external FFmpeg executable to use in place of default found in PATH.")]
         public string FFmpegPath { get; set; }
 
+        /// <inheritdoc />
         [Option("service", Required = false, HelpText = "Run as headless service.")]
         public bool IsService { get; set; }
 
+        /// <inheritdoc />
         [Option("noautorunwebapp", Required = false, HelpText = "Run headless if startup wizard is complete.")]
         public bool NoAutoRunWebApp { get; set; }
 
+        /// <inheritdoc />
         [Option("package-name", Required = false, HelpText = "Used when packaging Jellyfin (example, synology).")]
         public string PackageName { get; set; }
 
+        /// <inheritdoc />
         [Option("restartpath", Required = false, HelpText = "Path to restart script.")]
         public string RestartPath { get; set; }
 
+        /// <inheritdoc />
         [Option("restartargs", Required = false, HelpText = "Arguments for restart script.")]
         public string RestartArgs { get; set; }
     }
-- 
cgit v1.2.3