diff options
| author | crobibero <cody@robibe.ro> | 2020-05-17 19:56:02 -0600 |
|---|---|---|
| committer | crobibero <cody@robibe.ro> | 2020-05-17 19:56:02 -0600 |
| commit | 37f55b5c217db5343ab196094f67dc84e71d4ef0 (patch) | |
| tree | c8e1cb4358dcbcd1d7689eaa07b3473446e77d58 /Jellyfin.Api/Controllers/StartupController.cs | |
| parent | 7a3925b863a12bea492a93f41cda4eb92dc9c183 (diff) | |
apply doc suggestions
Diffstat (limited to 'Jellyfin.Api/Controllers/StartupController.cs')
| -rw-r--r-- | Jellyfin.Api/Controllers/StartupController.cs | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/Jellyfin.Api/Controllers/StartupController.cs b/Jellyfin.Api/Controllers/StartupController.cs index 66e4774aa..ed1dc1ede 100644 --- a/Jellyfin.Api/Controllers/StartupController.cs +++ b/Jellyfin.Api/Controllers/StartupController.cs @@ -34,7 +34,7 @@ namespace Jellyfin.Api.Controllers /// Completes the startup wizard. /// </summary> /// <response code="200">Startup wizard completed.</response> - /// <returns>Status.</returns> + /// <returns>An <see cref="OkResult"/> indicating success.</returns> [HttpPost("Complete")] [ProducesResponseType(StatusCodes.Status200OK)] public ActionResult CompleteWizard() @@ -49,7 +49,7 @@ namespace Jellyfin.Api.Controllers /// Gets the initial startup wizard configuration. /// </summary> /// <response code="200">Initial startup wizard configuration retrieved.</response> - /// <returns>The initial startup wizard configuration.</returns> + /// <returns>An <see cref="OkResult"/> containing the initial startup wizard configuration.</returns> [HttpGet("Configuration")] [ProducesResponseType(StatusCodes.Status200OK)] public ActionResult<StartupConfigurationDto> GetStartupConfiguration() @@ -71,7 +71,7 @@ namespace Jellyfin.Api.Controllers /// <param name="metadataCountryCode">The metadata country code.</param> /// <param name="preferredMetadataLanguage">The preferred language for metadata.</param> /// <response code="200">Configuration saved.</response> - /// <returns>Status.</returns> + /// <returns>An <see cref="OkResult"/> indicating success.</returns> [HttpPost("Configuration")] [ProducesResponseType(StatusCodes.Status200OK)] public ActionResult UpdateInitialConfiguration( @@ -92,7 +92,7 @@ namespace Jellyfin.Api.Controllers /// <param name="enableRemoteAccess">Enable remote access.</param> /// <param name="enableAutomaticPortMapping">Enable UPnP.</param> /// <response code="200">Configuration saved.</response> - /// <returns>Status.</returns> + /// <returns>An <see cref="OkResult"/> indicating success.</returns> [HttpPost("RemoteAccess")] [ProducesResponseType(StatusCodes.Status200OK)] public ActionResult SetRemoteAccess([FromForm] bool enableRemoteAccess, [FromForm] bool enableAutomaticPortMapping) @@ -121,7 +121,10 @@ namespace Jellyfin.Api.Controllers /// </summary> /// <param name="startupUserDto">The DTO containing username and password.</param> /// <response code="200">Updated user name and password.</response> - /// <returns>The async task.</returns> + /// <returns> + /// A <see cref="Task" /> that represents the asynchronous update operation. + /// The task result contains an <see cref="OkResult"/> indicating success. + /// </returns> [HttpPost("User")] [ProducesResponseType(StatusCodes.Status200OK)] public async Task<ActionResult> UpdateUser([FromForm] StartupUserDto startupUserDto) |