diff options
author | Jesse Plamondon-Willard <github@jplamondonw.com> | 2017-09-21 23:35:18 -0400 |
---|---|---|
committer | Jesse Plamondon-Willard <github@jplamondonw.com> | 2017-09-21 23:35:18 -0400 |
commit | 9791de306c22c744732219dadfd97b7dd556a5b2 (patch) | |
tree | f320674827f3535cf238106070fefd5a762a2a0f /Dewdrop/Models/NexusResponseModel.cs | |
parent | 57d9d28554de79734401a68ee1151fc4e9e0ca83 (diff) | |
download | SMAPI-9791de306c22c744732219dadfd97b7dd556a5b2.tar.gz SMAPI-9791de306c22c744732219dadfd97b7dd556a5b2.tar.bz2 SMAPI-9791de306c22c744732219dadfd97b7dd556a5b2.zip |
minor cleanup, formatting, documentation (#336)
Diffstat (limited to 'Dewdrop/Models/NexusResponseModel.cs')
-rw-r--r-- | Dewdrop/Models/NexusResponseModel.cs | 47 |
1 files changed, 20 insertions, 27 deletions
diff --git a/Dewdrop/Models/NexusResponseModel.cs b/Dewdrop/Models/NexusResponseModel.cs index e954a8bc..fa663910 100644 --- a/Dewdrop/Models/NexusResponseModel.cs +++ b/Dewdrop/Models/NexusResponseModel.cs @@ -1,46 +1,39 @@ -using System; -using Newtonsoft.Json; +using Newtonsoft.Json; namespace Dewdrop.Models { + /// <summary>A mod metadata response from Nexus Mods.</summary> public class NexusResponseModel : IModModel { - /// <summary> - /// The name of the mod. - /// </summary> - [JsonProperty("name")] + /********* + ** Accessors + *********/ + /// <summary>The unique mod ID.</summary> + public int ID { get; set; } + + /// <summary>The mod name.</summary> public string Name { get; set; } - /// <summary> - /// The version of the mod. - /// </summary> - [JsonProperty("version")] + /// <summary>The mod's semantic version number.</summary> public string Version { get; set; } - /// <summary> - /// The NexusMod ID for the mod. - /// </summary> - [JsonProperty("id")] - public int Id { get; set; } - - /// <summary> - /// The URL of the mod. - /// </summary> + /// <summary>The mod's web URL.</summary> [JsonProperty("mod_page_uri")] public string Url { get; set; } - /// <summary> - /// Return mod information about a Nexus mod - /// </summary> - /// <returns><see cref="ModGenericModel"/></returns> + + /********* + ** Public methods + *********/ + /// <summary>Get basic mod metadata.</summary> public ModGenericModel ModInfo() { return new ModGenericModel { - Id = Id, - Version = Version, - Name = Name, - Url = Url, + ID = this.ID, + Version = this.Version, + Name = this.Name, + Url = this.Url, Vendor = "Nexus" }; } |