tweak comment header convention

This commit is contained in:
Jesse Plamondon-Willard 2018-12-27 12:39:10 -05:00
parent 51e65fc8a0
commit c4a82418ac
No known key found for this signature in database
GPG Key ID: 7D7C8097B62033CE
142 changed files with 145 additions and 145 deletions

View File

@ -22,7 +22,7 @@ namespace StardewModdingApi.Installer
internal class InteractiveInstaller internal class InteractiveInstaller
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The absolute path to the directory containing the files to copy into the game folder.</summary> /// <summary>The absolute path to the directory containing the files to copy into the game folder.</summary>
private readonly string BundlePath; private readonly string BundlePath;

View File

@ -12,7 +12,7 @@ namespace StardewModdingApi.Installer
internal class Program internal class Program
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The absolute path of the installer folder.</summary> /// <summary>The absolute path of the installer folder.</summary>
[SuppressMessage("ReSharper", "AssignNullToNotNullAttribute", Justification = "The assembly location is never null in this context.")] [SuppressMessage("ReSharper", "AssignNullToNotNullAttribute", Justification = "The assembly location is never null in this context.")]

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Internal.ConsoleWriting
internal class ColorfulConsoleWriter internal class ColorfulConsoleWriter
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The console text color for each log level.</summary> /// <summary>The console text color for each log level.</summary>
private readonly IDictionary<ConsoleLogLevel, ConsoleColor> Colors; private readonly IDictionary<ConsoleLogLevel, ConsoleColor> Colors;

View File

@ -12,7 +12,7 @@ namespace StardewModdingAPI.Internal
internal static class EnvironmentUtility internal static class EnvironmentUtility
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Get the OS name from the system uname command.</summary> /// <summary>Get the OS name from the system uname command.</summary>
/// <param name="buffer">The buffer to fill with the resulting string.</param> /// <param name="buffer">The buffer to fill with the resulting string.</param>

View File

@ -11,7 +11,7 @@ namespace SMAPI.ModBuildConfig.Analyzer.Tests
public class NetFieldAnalyzerTests : DiagnosticVerifier public class NetFieldAnalyzerTests : DiagnosticVerifier
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Sample C# mod code, with a {{test-code}} placeholder for the code in the Entry method to test.</summary> /// <summary>Sample C# mod code, with a {{test-code}} placeholder for the code in the Entry method to test.</summary>
const string SampleProgram = @" const string SampleProgram = @"

View File

@ -11,7 +11,7 @@ namespace SMAPI.ModBuildConfig.Analyzer.Tests
public class ObsoleteFieldAnalyzerTests : DiagnosticVerifier public class ObsoleteFieldAnalyzerTests : DiagnosticVerifier
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Sample C# mod code, with a {{test-code}} placeholder for the code in the Entry method to test.</summary> /// <summary>Sample C# mod code, with a {{test-code}} placeholder for the code in the Entry method to test.</summary>
const string SampleProgram = @" const string SampleProgram = @"

View File

@ -14,7 +14,7 @@ namespace StardewModdingAPI.ModBuildConfig.Analyzer
public class NetFieldAnalyzer : DiagnosticAnalyzer public class NetFieldAnalyzer : DiagnosticAnalyzer
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The namespace for Stardew Valley's <c>Netcode</c> types.</summary> /// <summary>The namespace for Stardew Valley's <c>Netcode</c> types.</summary>
private const string NetcodeNamespace = "Netcode"; private const string NetcodeNamespace = "Netcode";

View File

@ -12,7 +12,7 @@ namespace StardewModdingAPI.ModBuildConfig.Analyzer
public class ObsoleteFieldAnalyzer : DiagnosticAnalyzer public class ObsoleteFieldAnalyzer : DiagnosticAnalyzer
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Maps obsolete fields/properties to their non-obsolete equivalent.</summary> /// <summary>Maps obsolete fields/properties to their non-obsolete equivalent.</summary>
private readonly IDictionary<string, string> ReplacedFields = new Dictionary<string, string> private readonly IDictionary<string, string> ReplacedFields = new Dictionary<string, string>

View File

@ -12,7 +12,7 @@ namespace StardewModdingAPI.ModBuildConfig.Framework
internal class ModFileManager internal class ModFileManager
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The name of the manifest file.</summary> /// <summary>The name of the manifest file.</summary>
private readonly string ManifestFileName = "manifest.json"; private readonly string ManifestFileName = "manifest.json";

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands
internal class ArgumentParser : IReadOnlyList<string> internal class ArgumentParser : IReadOnlyList<string>
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The command name for errors.</summary> /// <summary>The command name for errors.</summary>
private readonly string CommandName; private readonly string CommandName;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
internal class AddCommand : TrainerCommand internal class AddCommand : TrainerCommand
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Provides methods for searching and constructing items.</summary> /// <summary>Provides methods for searching and constructing items.</summary>
private readonly ItemRepository Items = new ItemRepository(); private readonly ItemRepository Items = new ItemRepository();

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
internal class ListItemTypesCommand : TrainerCommand internal class ListItemTypesCommand : TrainerCommand
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Provides methods for searching and constructing items.</summary> /// <summary>Provides methods for searching and constructing items.</summary>
private readonly ItemRepository Items = new ItemRepository(); private readonly ItemRepository Items = new ItemRepository();

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
internal class ListItemsCommand : TrainerCommand internal class ListItemsCommand : TrainerCommand
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Provides methods for searching and constructing items.</summary> /// <summary>Provides methods for searching and constructing items.</summary>
private readonly ItemRepository Items = new ItemRepository(); private readonly ItemRepository Items = new ItemRepository();

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
internal class SetHealthCommand : TrainerCommand internal class SetHealthCommand : TrainerCommand
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Whether to keep the player's health at its maximum.</summary> /// <summary>Whether to keep the player's health at its maximum.</summary>
private bool InfiniteHealth; private bool InfiniteHealth;

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
internal class SetMoneyCommand : TrainerCommand internal class SetMoneyCommand : TrainerCommand
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Whether to keep the player's money at a set value.</summary> /// <summary>Whether to keep the player's money at a set value.</summary>
private bool InfiniteMoney; private bool InfiniteMoney;

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.Player
internal class SetStaminaCommand : TrainerCommand internal class SetStaminaCommand : TrainerCommand
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Whether to keep the player's stamina at its maximum.</summary> /// <summary>Whether to keep the player's stamina at its maximum.</summary>
private bool InfiniteStamina; private bool InfiniteStamina;

View File

@ -13,7 +13,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.World
internal class ClearCommand : TrainerCommand internal class ClearCommand : TrainerCommand
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The valid types that can be cleared.</summary> /// <summary>The valid types that can be cleared.</summary>
private readonly string[] ValidTypes = { "debris", "fruit-trees", "grass", "trees", "everything" }; private readonly string[] ValidTypes = { "debris", "fruit-trees", "grass", "trees", "everything" };

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.World
internal class FreezeTimeCommand : TrainerCommand internal class FreezeTimeCommand : TrainerCommand
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The time of day at which to freeze time.</summary> /// <summary>The time of day at which to freeze time.</summary>
internal static int FrozenTime; internal static int FrozenTime;

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework.Commands.World
internal class SetSeasonCommand : TrainerCommand internal class SetSeasonCommand : TrainerCommand
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The valid season names.</summary> /// <summary>The valid season names.</summary>
private readonly string[] ValidSeasons = { "winter", "spring", "summer", "fall" }; private readonly string[] ValidSeasons = { "winter", "spring", "summer", "fall" };

View File

@ -12,7 +12,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands.Framework
internal class ItemRepository internal class ItemRepository
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The custom ID offset for items don't have a unique ID in the game.</summary> /// <summary>The custom ID offset for items don't have a unique ID in the game.</summary>
private readonly int CustomIDOffset = 1000; private readonly int CustomIDOffset = 1000;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Mods.ConsoleCommands
public class ModEntry : Mod public class ModEntry : Mod
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The commands to handle.</summary> /// <summary>The commands to handle.</summary>
private ITrainerCommand[] Commands; private ITrainerCommand[] Commands;

View File

@ -12,7 +12,7 @@ namespace StardewModdingAPI.Mods.SaveBackup
public class ModEntry : Mod public class ModEntry : Mod
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The number of backups to keep.</summary> /// <summary>The number of backups to keep.</summary>
private readonly int BackupsToKeep = 10; private readonly int BackupsToKeep = 10;

View File

@ -1,4 +1,4 @@
using System; using System;
namespace StardewModdingAPI.Tests namespace StardewModdingAPI.Tests
{ {
@ -6,14 +6,14 @@ namespace StardewModdingAPI.Tests
internal static class Sample internal static class Sample
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>A random number generator.</summary> /// <summary>A random number generator.</summary>
private static readonly Random Random = new Random(); private static readonly Random Random = new Random();
/********* /*********
** Properties ** Accessors
*********/ *********/
/// <summary>Get a sample string.</summary> /// <summary>Get a sample string.</summary>
public static string String() public static string String()

View File

@ -13,7 +13,7 @@ namespace StardewModdingAPI.Tests.Utilities
internal class SDateTests internal class SDateTests
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>All valid seasons.</summary> /// <summary>All valid seasons.</summary>
private static readonly string[] ValidSeasons = { "spring", "summer", "fall", "winter" }; private static readonly string[] ValidSeasons = { "spring", "summer", "fall", "winter" };

View File

@ -20,7 +20,7 @@ namespace StardewModdingAPI.Web.Controllers
internal class IndexController : Controller internal class IndexController : Controller
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The site config settings.</summary> /// <summary>The site config settings.</summary>
private readonly SiteConfig SiteConfig; private readonly SiteConfig SiteConfig;

View File

@ -19,7 +19,7 @@ namespace StardewModdingAPI.Web.Controllers
internal class LogParserController : Controller internal class LogParserController : Controller
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The site config settings.</summary> /// <summary>The site config settings.</summary>
private readonly SiteConfig Config; private readonly SiteConfig Config;

View File

@ -28,7 +28,7 @@ namespace StardewModdingAPI.Web.Controllers
internal class ModsApiController : Controller internal class ModsApiController : Controller
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The mod repositories which provide mod metadata.</summary> /// <summary>The mod repositories which provide mod metadata.</summary>
private readonly IDictionary<ModRepositoryKey, IModRepository> Repositories; private readonly IDictionary<ModRepositoryKey, IModRepository> Repositories;

View File

@ -16,7 +16,7 @@ namespace StardewModdingAPI.Web.Controllers
internal class ModsController : Controller internal class ModsController : Controller
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The cache in which to store mod metadata.</summary> /// <summary>The cache in which to store mod metadata.</summary>
private readonly IMemoryCache Cache; private readonly IMemoryCache Cache;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Web.Framework
public class AllowLargePostsAttribute : Attribute, IAuthorizationFilter, IOrderedFilter public class AllowLargePostsAttribute : Attribute, IAuthorizationFilter, IOrderedFilter
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying form options.</summary> /// <summary>The underlying form options.</summary>
private readonly FormOptions FormOptions; private readonly FormOptions FormOptions;

View File

@ -12,7 +12,7 @@ namespace StardewModdingAPI.Web.Framework
internal class BeanstalkEnvPropsConfigProvider : ConfigurationProvider, IConfigurationSource internal class BeanstalkEnvPropsConfigProvider : ConfigurationProvider, IConfigurationSource
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The absolute path to the container configuration file on an Amazon EC2 instance.</summary> /// <summary>The absolute path to the container configuration file on an Amazon EC2 instance.</summary>
private const string ContainerConfigPath = @"C:\Program Files\Amazon\ElasticBeanstalk\config\containerconfiguration"; private const string ContainerConfigPath = @"C:\Program Files\Amazon\ElasticBeanstalk\config\containerconfiguration";

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Web.Framework.Clients.Chucklefish
internal class ChucklefishClient : IChucklefishClient internal class ChucklefishClient : IChucklefishClient
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The URL for a mod page excluding the base URL, where {0} is the mod ID.</summary> /// <summary>The URL for a mod page excluding the base URL, where {0} is the mod ID.</summary>
private readonly string ModPageUrlFormat; private readonly string ModPageUrlFormat;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Web.Framework.Clients.GitHub
internal class GitHubClient : IGitHubClient internal class GitHubClient : IGitHubClient
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The URL for a GitHub API query for the latest stable release, excluding the base URL, where {0} is the organisation and project name.</summary> /// <summary>The URL for a GitHub API query for the latest stable release, excluding the base URL, where {0} is the organisation and project name.</summary>
private readonly string StableReleaseUrlFormat; private readonly string StableReleaseUrlFormat;

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Web.Framework.Clients.ModDrop
internal class ModDropClient : IModDropClient internal class ModDropClient : IModDropClient
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying HTTP client.</summary> /// <summary>The underlying HTTP client.</summary>
private readonly IClient Client; private readonly IClient Client;

View File

@ -13,7 +13,7 @@ namespace StardewModdingAPI.Web.Framework.Clients.Nexus
internal class NexusWebScrapeClient : INexusClient internal class NexusWebScrapeClient : INexusClient
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The URL for a Nexus mod page for the user, excluding the base URL, where {0} is the mod ID.</summary> /// <summary>The URL for a Nexus mod page for the user, excluding the base URL, where {0} is the mod ID.</summary>
private readonly string ModUrlFormat; private readonly string ModUrlFormat;

View File

@ -14,7 +14,7 @@ namespace StardewModdingAPI.Web.Framework.Clients.Pastebin
internal class PastebinClient : IPastebinClient internal class PastebinClient : IPastebinClient
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying HTTP client.</summary> /// <summary>The underlying HTTP client.</summary>
private readonly IClient Client; private readonly IClient Client;

View File

@ -12,7 +12,7 @@ namespace StardewModdingAPI.Web.Framework.LogParsing
public class LogParser public class LogParser
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>A regex pattern matching the start of a SMAPI message.</summary> /// <summary>A regex pattern matching the start of a SMAPI message.</summary>
private readonly Regex MessageHeaderPattern = new Regex(@"^\[(?<time>\d\d:\d\d:\d\d) (?<level>[a-z]+) +(?<modName>[^\]]+)\] ", RegexOptions.Compiled | RegexOptions.IgnoreCase); private readonly Regex MessageHeaderPattern = new Regex(@"^\[(?<time>\d\d:\d\d:\d\d) (?<level>[a-z]+) +(?<modName>[^\]]+)\] ", RegexOptions.Compiled | RegexOptions.IgnoreCase);

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories
internal class ChucklefishRepository : RepositoryBase internal class ChucklefishRepository : RepositoryBase
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying HTTP client.</summary> /// <summary>The underlying HTTP client.</summary>
private readonly IChucklefishClient Client; private readonly IChucklefishClient Client;

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories
internal class GitHubRepository : RepositoryBase internal class GitHubRepository : RepositoryBase
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying GitHub API client.</summary> /// <summary>The underlying GitHub API client.</summary>
private readonly IGitHubClient Client; private readonly IGitHubClient Client;

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories
internal class ModDropRepository : RepositoryBase internal class ModDropRepository : RepositoryBase
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying ModDrop API client.</summary> /// <summary>The underlying ModDrop API client.</summary>
private readonly IModDropClient Client; private readonly IModDropClient Client;

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Web.Framework.ModRepositories
internal class NexusRepository : RepositoryBase internal class NexusRepository : RepositoryBase
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying Nexus Mods API client.</summary> /// <summary>The underlying Nexus Mods API client.</summary>
private readonly INexusClient Client; private readonly INexusClient Client;

View File

@ -11,7 +11,7 @@ namespace StardewModdingAPI.Web.Framework.RewriteRules
internal class ConditionalRedirectToHttpsRule : IRule internal class ConditionalRedirectToHttpsRule : IRule
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>A predicate which indicates when the rule should be applied.</summary> /// <summary>A predicate which indicates when the rule should be applied.</summary>
private readonly Func<HttpRequest, bool> ShouldRewrite; private readonly Func<HttpRequest, bool> ShouldRewrite;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Web.Framework.RewriteRules
internal class RedirectToUrlRule : IRule internal class RedirectToUrlRule : IRule
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Get the new URL to which to redirect (or <c>null</c> to skip).</summary> /// <summary>Get the new URL to which to redirect (or <c>null</c> to skip).</summary>
private readonly Func<HttpRequest, string> NewUrl; private readonly Func<HttpRequest, string> NewUrl;

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Web.ViewModels
public class LogParserModel public class LogParserModel
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>A regex pattern matching characters to remove from a mod name to create the slug ID.</summary> /// <summary>A regex pattern matching characters to remove from a mod name to create the slug ID.</summary>
private readonly Regex SlugInvalidCharPattern = new Regex("[^a-z0-9]", RegexOptions.Compiled | RegexOptions.IgnoreCase); private readonly Regex SlugInvalidCharPattern = new Regex("[^a-z0-9]", RegexOptions.Compiled | RegexOptions.IgnoreCase);

View File

@ -13,7 +13,7 @@ namespace StardewModdingAPI
public static class Constants public static class Constants
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The directory path containing the current save's data (if a save is loaded).</summary> /// <summary>The directory path containing the current save's data (if a save is loaded).</summary>
private static string RawSavePath => Context.IsSaveLoaded ? Path.Combine(Constants.SavesPath, Constants.GetSaveFolderName()) : null; private static string RawSavePath => Context.IsSaveLoaded ? Path.Combine(Constants.SavesPath, Constants.GetSaveFolderName()) : null;

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Events
public class ButtonPressedEventArgs : EventArgs public class ButtonPressedEventArgs : EventArgs
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The game's current input state.</summary> /// <summary>The game's current input state.</summary>
private readonly SInputState InputState; private readonly SInputState InputState;

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Events
public class ButtonReleasedEventArgs : EventArgs public class ButtonReleasedEventArgs : EventArgs
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The game's current input state.</summary> /// <summary>The game's current input state.</summary>
private readonly SInputState InputState; private readonly SInputState InputState;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
public static class ContentEvents public static class ContentEvents
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The core event manager.</summary> /// <summary>The core event manager.</summary>
private static EventManager EventManager; private static EventManager EventManager;

View File

@ -11,7 +11,7 @@ namespace StardewModdingAPI.Events
public static class ControlEvents public static class ControlEvents
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The core event manager.</summary> /// <summary>The core event manager.</summary>
private static EventManager EventManager; private static EventManager EventManager;

View File

@ -8,7 +8,7 @@ namespace StardewModdingAPI.Events
public class EventArgsInput : EventArgs public class EventArgsInput : EventArgs
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The buttons to suppress.</summary> /// <summary>The buttons to suppress.</summary>
private readonly HashSet<SButton> SuppressButtons; private readonly HashSet<SButton> SuppressButtons;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
public static class GameEvents public static class GameEvents
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The core event manager.</summary> /// <summary>The core event manager.</summary>
private static EventManager EventManager; private static EventManager EventManager;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
public static class GraphicsEvents public static class GraphicsEvents
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The core event manager.</summary> /// <summary>The core event manager.</summary>
private static EventManager EventManager; private static EventManager EventManager;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
public static class InputEvents public static class InputEvents
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The core event manager.</summary> /// <summary>The core event manager.</summary>
private static EventManager EventManager; private static EventManager EventManager;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
public static class LocationEvents public static class LocationEvents
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The core event manager.</summary> /// <summary>The core event manager.</summary>
private static EventManager EventManager; private static EventManager EventManager;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
public static class MenuEvents public static class MenuEvents
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The core event manager.</summary> /// <summary>The core event manager.</summary>
private static EventManager EventManager; private static EventManager EventManager;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
public static class MineEvents public static class MineEvents
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The core event manager.</summary> /// <summary>The core event manager.</summary>
private static EventManager EventManager; private static EventManager EventManager;

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Events
public class ModMessageReceivedEventArgs : EventArgs public class ModMessageReceivedEventArgs : EventArgs
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying message model.</summary> /// <summary>The underlying message model.</summary>
private readonly ModMessageModel Message; private readonly ModMessageModel Message;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
public static class MultiplayerEvents public static class MultiplayerEvents
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The core event manager.</summary> /// <summary>The core event manager.</summary>
private static EventManager EventManager; private static EventManager EventManager;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
public static class PlayerEvents public static class PlayerEvents
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The core event manager.</summary> /// <summary>The core event manager.</summary>
private static EventManager EventManager; private static EventManager EventManager;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
public static class SaveEvents public static class SaveEvents
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The core event manager.</summary> /// <summary>The core event manager.</summary>
private static EventManager EventManager; private static EventManager EventManager;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
public static class SpecialisedEvents public static class SpecialisedEvents
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The core event manager.</summary> /// <summary>The core event manager.</summary>
private static EventManager EventManager; private static EventManager EventManager;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Events
public static class TimeEvents public static class TimeEvents
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The core event manager.</summary> /// <summary>The core event manager.</summary>
private static EventManager EventManager; private static EventManager EventManager;

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework
internal class CommandManager internal class CommandManager
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The commands registered with SMAPI.</summary> /// <summary>The commands registered with SMAPI.</summary>
private readonly IDictionary<string, Command> Commands = new Dictionary<string, Command>(StringComparer.InvariantCultureIgnoreCase); private readonly IDictionary<string, Command> Commands = new Dictionary<string, Command>(StringComparer.InvariantCultureIgnoreCase);

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.Content
internal class AssetData<TValue> : AssetInfo, IAssetData<TValue> internal class AssetData<TValue> : AssetInfo, IAssetData<TValue>
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>A callback to invoke when the data is replaced (if any).</summary> /// <summary>A callback to invoke when the data is replaced (if any).</summary>
private readonly Action<TValue> OnDataReplaced; private readonly Action<TValue> OnDataReplaced;

View File

@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.Content
internal class AssetDataForImage : AssetData<Texture2D>, IAssetDataForImage internal class AssetDataForImage : AssetData<Texture2D>, IAssetDataForImage
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The minimum value to consider non-transparent.</summary> /// <summary>The minimum value to consider non-transparent.</summary>
/// <remarks>On Linux/Mac, fully transparent pixels may have an alpha up to 4 for some reason.</remarks> /// <remarks>On Linux/Mac, fully transparent pixels may have an alpha up to 4 for some reason.</remarks>

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.Content
internal class AssetInfo : IAssetInfo internal class AssetInfo : IAssetInfo
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Normalises an asset key to match the cache key.</summary> /// <summary>Normalises an asset key to match the cache key.</summary>
protected readonly Func<string, string> GetNormalisedPath; protected readonly Func<string, string> GetNormalisedPath;

View File

@ -14,7 +14,7 @@ namespace StardewModdingAPI.Framework.Content
internal class ContentCache internal class ContentCache
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying asset cache.</summary> /// <summary>The underlying asset cache.</summary>
private readonly IDictionary<string, object> Cache; private readonly IDictionary<string, object> Cache;

View File

@ -19,7 +19,7 @@ namespace StardewModdingAPI.Framework
internal class ContentCoordinator : IDisposable internal class ContentCoordinator : IDisposable
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>An asset key prefix for assets from SMAPI mod folders.</summary> /// <summary>An asset key prefix for assets from SMAPI mod folders.</summary>
private readonly string ManagedPrefix = "SMAPI"; private readonly string ManagedPrefix = "SMAPI";

View File

@ -18,7 +18,7 @@ namespace StardewModdingAPI.Framework.ContentManagers
internal abstract class BaseContentManager : LocalizedContentManager, IContentManager internal abstract class BaseContentManager : LocalizedContentManager, IContentManager
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The central coordinator which manages content managers.</summary> /// <summary>The central coordinator which manages content managers.</summary>
protected readonly ContentCoordinator Coordinator; protected readonly ContentCoordinator Coordinator;

View File

@ -14,7 +14,7 @@ namespace StardewModdingAPI.Framework.ContentManagers
internal class GameContentManager : BaseContentManager internal class GameContentManager : BaseContentManager
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The assets currently being intercepted by <see cref="IAssetLoader"/> instances. This is used to prevent infinite loops when a loader loads a new asset.</summary> /// <summary>The assets currently being intercepted by <see cref="IAssetLoader"/> instances. This is used to prevent infinite loops when a loader loads a new asset.</summary>
private readonly ContextHash<string> AssetsBeingLoaded = new ContextHash<string>(); private readonly ContextHash<string> AssetsBeingLoaded = new ContextHash<string>();

View File

@ -14,7 +14,7 @@ namespace StardewModdingAPI.Framework.ContentManagers
internal class ModContentManager : BaseContentManager internal class ModContentManager : BaseContentManager
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Encapsulates SMAPI's JSON file parsing.</summary> /// <summary>Encapsulates SMAPI's JSON file parsing.</summary>
private readonly JsonHelper JsonHelper; private readonly JsonHelper JsonHelper;

View File

@ -12,7 +12,7 @@ namespace StardewModdingAPI.Framework
internal class ContentPack : IContentPack internal class ContentPack : IContentPack
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Provides an API for loading content assets.</summary> /// <summary>Provides an API for loading content assets.</summary>
private readonly IContentHelper Content; private readonly IContentHelper Content;

View File

@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework
internal class DeprecationManager internal class DeprecationManager
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The deprecations which have already been logged (as 'mod name::noun phrase::version').</summary> /// <summary>The deprecations which have already been logged (as 'mod name::noun phrase::version').</summary>
private readonly HashSet<string> LoggedDeprecations = new HashSet<string>(StringComparer.InvariantCultureIgnoreCase); private readonly HashSet<string> LoggedDeprecations = new HashSet<string>(StringComparer.InvariantCultureIgnoreCase);

View File

@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.Events
internal class ManagedEvent<TEventArgs> : ManagedEventBase<EventHandler<TEventArgs>> internal class ManagedEvent<TEventArgs> : ManagedEventBase<EventHandler<TEventArgs>>
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying event.</summary> /// <summary>The underlying event.</summary>
private event EventHandler<TEventArgs> Event; private event EventHandler<TEventArgs> Event;
@ -98,7 +98,7 @@ namespace StardewModdingAPI.Framework.Events
internal class ManagedEvent : ManagedEventBase<EventHandler> internal class ManagedEvent : ManagedEventBase<EventHandler>
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying event.</summary> /// <summary>The underlying event.</summary>
private event EventHandler Event; private event EventHandler Event;

View File

@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.Events
internal abstract class ManagedEventBase<TEventHandler> internal abstract class ManagedEventBase<TEventHandler>
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>A human-readable name for the event.</summary> /// <summary>A human-readable name for the event.</summary>
private readonly string EventName; private readonly string EventName;

View File

@ -4,7 +4,7 @@ namespace StardewModdingAPI.Framework.Events
internal abstract class ModEventsBase internal abstract class ModEventsBase
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying event manager.</summary> /// <summary>The underlying event manager.</summary>
protected readonly EventManager EventManager; protected readonly EventManager EventManager;

View File

@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.Input
internal class GamePadStateBuilder internal class GamePadStateBuilder
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The current button states.</summary> /// <summary>The current button states.</summary>
private readonly IDictionary<SButton, ButtonState> ButtonStates; private readonly IDictionary<SButton, ButtonState> ButtonStates;

View File

@ -6,7 +6,7 @@ namespace StardewModdingAPI.Framework.Logging
internal class ConsoleInterceptionManager : IDisposable internal class ConsoleInterceptionManager : IDisposable
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The intercepting console writer.</summary> /// <summary>The intercepting console writer.</summary>
private readonly InterceptingTextWriter Output; private readonly InterceptingTextWriter Output;

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.Logging
internal class LogFileManager : IDisposable internal class LogFileManager : IDisposable
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying stream writer.</summary> /// <summary>The underlying stream writer.</summary>
private readonly StreamWriter Stream; private readonly StreamWriter Stream;

View File

@ -6,7 +6,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
internal class CommandHelper : BaseHelper, ICommandHelper internal class CommandHelper : BaseHelper, ICommandHelper
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The mod using this instance.</summary> /// <summary>The mod using this instance.</summary>
private readonly IModMetadata Mod; private readonly IModMetadata Mod;

View File

@ -21,7 +21,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
internal class ContentHelper : BaseHelper, IContentHelper internal class ContentHelper : BaseHelper, IContentHelper
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>SMAPI's core content logic.</summary> /// <summary>SMAPI's core content logic.</summary>
private readonly ContentCoordinator ContentCore; private readonly ContentCoordinator ContentCore;

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
internal class ContentPackHelper : BaseHelper, IContentPackHelper internal class ContentPackHelper : BaseHelper, IContentPackHelper
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The content packs loaded for this mod.</summary> /// <summary>The content packs loaded for this mod.</summary>
private readonly Lazy<IContentPack[]> ContentPacks; private readonly Lazy<IContentPack[]> ContentPacks;

View File

@ -11,7 +11,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
internal class DataHelper : BaseHelper, IDataHelper internal class DataHelper : BaseHelper, IDataHelper
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Encapsulates SMAPI's JSON file parsing.</summary> /// <summary>Encapsulates SMAPI's JSON file parsing.</summary>
private readonly JsonHelper JsonHelper; private readonly JsonHelper JsonHelper;

View File

@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
internal class ModRegistryHelper : BaseHelper, IModRegistry internal class ModRegistryHelper : BaseHelper, IModRegistry
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying mod registry.</summary> /// <summary>The underlying mod registry.</summary>
private readonly ModRegistry Registry; private readonly ModRegistry Registry;

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
internal class MultiplayerHelper : BaseHelper, IMultiplayerHelper internal class MultiplayerHelper : BaseHelper, IMultiplayerHelper
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>SMAPI's core multiplayer utility.</summary> /// <summary>SMAPI's core multiplayer utility.</summary>
private readonly SMultiplayer Multiplayer; private readonly SMultiplayer Multiplayer;

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
internal class ReflectionHelper : BaseHelper, IReflectionHelper internal class ReflectionHelper : BaseHelper, IReflectionHelper
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The underlying reflection helper.</summary> /// <summary>The underlying reflection helper.</summary>
private readonly Reflector Reflector; private readonly Reflector Reflector;

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModHelpers
internal class TranslationHelper : BaseHelper, ITranslationHelper internal class TranslationHelper : BaseHelper, ITranslationHelper
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The name of the relevant mod for error messages.</summary> /// <summary>The name of the relevant mod for error messages.</summary>
private readonly string ModName; private readonly string ModName;

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading
internal class AssemblyDefinitionResolver : DefaultAssemblyResolver internal class AssemblyDefinitionResolver : DefaultAssemblyResolver
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The known assemblies.</summary> /// <summary>The known assemblies.</summary>
private readonly IDictionary<string, AssemblyDefinition> Lookup = new Dictionary<string, AssemblyDefinition>(); private readonly IDictionary<string, AssemblyDefinition> Lookup = new Dictionary<string, AssemblyDefinition>();

View File

@ -15,7 +15,7 @@ namespace StardewModdingAPI.Framework.ModLoading
internal class AssemblyLoader : IDisposable internal class AssemblyLoader : IDisposable
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>Encapsulates monitoring and logging.</summary> /// <summary>Encapsulates monitoring and logging.</summary>
private readonly IMonitor Monitor; private readonly IMonitor Monitor;

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders
internal class EventFinder : IInstructionHandler internal class EventFinder : IInstructionHandler
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The full type name for which to find references.</summary> /// <summary>The full type name for which to find references.</summary>
private readonly string FullTypeName; private readonly string FullTypeName;

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders
internal class FieldFinder : IInstructionHandler internal class FieldFinder : IInstructionHandler
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The full type name for which to find references.</summary> /// <summary>The full type name for which to find references.</summary>
private readonly string FullTypeName; private readonly string FullTypeName;

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders
internal class MethodFinder : IInstructionHandler internal class MethodFinder : IInstructionHandler
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The full type name for which to find references.</summary> /// <summary>The full type name for which to find references.</summary>
private readonly string FullTypeName; private readonly string FullTypeName;

View File

@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders
internal class PropertyFinder : IInstructionHandler internal class PropertyFinder : IInstructionHandler
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The full type name for which to find references.</summary> /// <summary>The full type name for which to find references.</summary>
private readonly string FullTypeName; private readonly string FullTypeName;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders
internal class ReferenceToMemberWithUnexpectedTypeFinder : IInstructionHandler internal class ReferenceToMemberWithUnexpectedTypeFinder : IInstructionHandler
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The assembly names to which to heuristically detect broken references.</summary> /// <summary>The assembly names to which to heuristically detect broken references.</summary>
private readonly HashSet<string> ValidateReferencesToAssemblies; private readonly HashSet<string> ValidateReferencesToAssemblies;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders
internal class ReferenceToMissingMemberFinder : IInstructionHandler internal class ReferenceToMissingMemberFinder : IInstructionHandler
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The assembly names to which to heuristically detect broken references.</summary> /// <summary>The assembly names to which to heuristically detect broken references.</summary>
private readonly HashSet<string> ValidateReferencesToAssemblies; private readonly HashSet<string> ValidateReferencesToAssemblies;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading
internal static class RewriteHelper internal static class RewriteHelper
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The comparer which heuristically compares type definitions.</summary> /// <summary>The comparer which heuristically compares type definitions.</summary>
private static readonly TypeReferenceComparer TypeDefinitionComparer = new TypeReferenceComparer(); private static readonly TypeReferenceComparer TypeDefinitionComparer = new TypeReferenceComparer();

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
internal class FieldReplaceRewriter : FieldFinder internal class FieldReplaceRewriter : FieldFinder
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The new field to reference.</summary> /// <summary>The new field to reference.</summary>
private readonly FieldInfo ToField; private readonly FieldInfo ToField;

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
internal class FieldToPropertyRewriter : FieldFinder internal class FieldToPropertyRewriter : FieldFinder
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The type whose field to which references should be rewritten.</summary> /// <summary>The type whose field to which references should be rewritten.</summary>
private readonly Type Type; private readonly Type Type;

View File

@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
internal class MethodParentRewriter : IInstructionHandler internal class MethodParentRewriter : IInstructionHandler
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The type whose methods to remap.</summary> /// <summary>The type whose methods to remap.</summary>
private readonly Type FromType; private readonly Type FromType;

View File

@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
internal class StaticFieldToConstantRewriter<TValue> : FieldFinder internal class StaticFieldToConstantRewriter<TValue> : FieldFinder
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The constant value to replace with.</summary> /// <summary>The constant value to replace with.</summary>
private readonly TValue Value; private readonly TValue Value;

View File

@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters
internal class TypeReferenceRewriter : TypeFinder internal class TypeReferenceRewriter : TypeFinder
{ {
/********* /*********
** Properties ** Fields
*********/ *********/
/// <summary>The full type name to which to find references.</summary> /// <summary>The full type name to which to find references.</summary>
private readonly string FromTypeName; private readonly string FromTypeName;

Some files were not shown because too many files have changed in this diff Show More