update documentation format and document field

This commit is contained in:
Dan Volchek 2018-04-19 01:35:15 -05:00
parent 43487a40e3
commit f451e172e2
1 changed files with 3 additions and 6 deletions

View File

@ -16,6 +16,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
/// <summary>Provides methods for searching and constructing items.</summary>
private readonly ItemRepository Items = new ItemRepository();
/// <summary>All possible item types along with Name.</summary>
private readonly string[] ItemTypeAndName = Enum.GetNames(typeof(ItemType)).Union(new string[] { "Name" }).ToArray();
/*********
@ -75,9 +76,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
** Private methods
*********/
/// <summary>
/// Finds a matching item by item type and id.
/// </summary>
/// <summary>Finds a matching item by item type and id.</summary>
/// <param name="monitor">Writes messages to the console and log file.</param>
/// <param name="args">The command arguments.</param>
/// <param name="rawType">The raw item type.</param>
@ -101,9 +100,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
}
}
/// <summary>
/// Finds a matching item by name.
/// </summary>
/// <summary>Finds a matching item by name.</summary>
/// <param name="monitor">Writes messages to the console and log file.</param>
/// <param name="args">The command arguments.</param>
/// <param name="name">The item name.</param>