From c4a82418ac8b09a6965052f5c9173928457fba52 Mon Sep 17 00:00:00 2001 From: Jesse Plamondon-Willard Date: Thu, 27 Dec 2018 12:39:10 -0500 Subject: tweak comment header convention --- src/SMAPI/Framework/CommandManager.cs | 2 +- src/SMAPI/Framework/Content/AssetData.cs | 2 +- src/SMAPI/Framework/Content/AssetDataForImage.cs | 2 +- src/SMAPI/Framework/Content/AssetInfo.cs | 2 +- src/SMAPI/Framework/Content/ContentCache.cs | 2 +- src/SMAPI/Framework/ContentCoordinator.cs | 2 +- src/SMAPI/Framework/ContentManagers/BaseContentManager.cs | 2 +- src/SMAPI/Framework/ContentManagers/GameContentManager.cs | 2 +- src/SMAPI/Framework/ContentManagers/ModContentManager.cs | 2 +- src/SMAPI/Framework/ContentPack.cs | 2 +- src/SMAPI/Framework/DeprecationManager.cs | 2 +- src/SMAPI/Framework/Events/ManagedEvent.cs | 4 ++-- src/SMAPI/Framework/Events/ManagedEventBase.cs | 2 +- src/SMAPI/Framework/Events/ModEventsBase.cs | 2 +- src/SMAPI/Framework/Input/GamePadStateBuilder.cs | 2 +- src/SMAPI/Framework/Logging/ConsoleInterceptionManager.cs | 2 +- src/SMAPI/Framework/Logging/LogFileManager.cs | 2 +- src/SMAPI/Framework/ModHelpers/CommandHelper.cs | 2 +- src/SMAPI/Framework/ModHelpers/ContentHelper.cs | 2 +- src/SMAPI/Framework/ModHelpers/ContentPackHelper.cs | 2 +- src/SMAPI/Framework/ModHelpers/DataHelper.cs | 2 +- src/SMAPI/Framework/ModHelpers/ModRegistryHelper.cs | 2 +- src/SMAPI/Framework/ModHelpers/MultiplayerHelper.cs | 2 +- src/SMAPI/Framework/ModHelpers/ReflectionHelper.cs | 2 +- src/SMAPI/Framework/ModHelpers/TranslationHelper.cs | 2 +- src/SMAPI/Framework/ModLoading/AssemblyDefinitionResolver.cs | 2 +- src/SMAPI/Framework/ModLoading/AssemblyLoader.cs | 2 +- src/SMAPI/Framework/ModLoading/Finders/EventFinder.cs | 2 +- src/SMAPI/Framework/ModLoading/Finders/FieldFinder.cs | 2 +- src/SMAPI/Framework/ModLoading/Finders/MethodFinder.cs | 2 +- src/SMAPI/Framework/ModLoading/Finders/PropertyFinder.cs | 2 +- .../ModLoading/Finders/ReferenceToMemberWithUnexpectedTypeFinder.cs | 2 +- .../Framework/ModLoading/Finders/ReferenceToMissingMemberFinder.cs | 2 +- src/SMAPI/Framework/ModLoading/RewriteHelper.cs | 2 +- src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs | 2 +- src/SMAPI/Framework/ModLoading/Rewriters/FieldToPropertyRewriter.cs | 2 +- src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs | 2 +- .../Framework/ModLoading/Rewriters/StaticFieldToConstantRewriter.cs | 2 +- src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs | 2 +- src/SMAPI/Framework/ModRegistry.cs | 2 +- src/SMAPI/Framework/Monitor.cs | 2 +- src/SMAPI/Framework/Networking/MultiplayerPeer.cs | 2 +- src/SMAPI/Framework/Networking/SGalaxyNetClient.cs | 2 +- src/SMAPI/Framework/Networking/SGalaxyNetServer.cs | 2 +- src/SMAPI/Framework/Networking/SLidgrenClient.cs | 2 +- src/SMAPI/Framework/Networking/SLidgrenServer.cs | 2 +- src/SMAPI/Framework/Patching/GamePatcher.cs | 2 +- src/SMAPI/Framework/Reflection/InterfaceProxyBuilder.cs | 2 +- src/SMAPI/Framework/Reflection/InterfaceProxyFactory.cs | 2 +- src/SMAPI/Framework/Reflection/ReflectedField.cs | 2 +- src/SMAPI/Framework/Reflection/ReflectedMethod.cs | 2 +- src/SMAPI/Framework/Reflection/ReflectedProperty.cs | 2 +- src/SMAPI/Framework/Reflection/Reflector.cs | 2 +- src/SMAPI/Framework/SCore.cs | 2 +- src/SMAPI/Framework/SGame.cs | 2 +- src/SMAPI/Framework/SModHooks.cs | 2 +- src/SMAPI/Framework/SMultiplayer.cs | 2 +- .../Framework/StateTracking/FieldWatchers/BaseDisposableWatcher.cs | 2 +- .../Framework/StateTracking/FieldWatchers/ComparableListWatcher.cs | 2 +- src/SMAPI/Framework/StateTracking/FieldWatchers/ComparableWatcher.cs | 2 +- .../Framework/StateTracking/FieldWatchers/NetCollectionWatcher.cs | 2 +- .../Framework/StateTracking/FieldWatchers/NetDictionaryWatcher.cs | 2 +- src/SMAPI/Framework/StateTracking/FieldWatchers/NetValueWatcher.cs | 2 +- .../StateTracking/FieldWatchers/ObservableCollectionWatcher.cs | 2 +- src/SMAPI/Framework/StateTracking/LocationTracker.cs | 2 +- src/SMAPI/Framework/StateTracking/PlayerTracker.cs | 2 +- src/SMAPI/Framework/StateTracking/WorldLocationsTracker.cs | 2 +- src/SMAPI/Framework/WatcherCore.cs | 2 +- 68 files changed, 69 insertions(+), 69 deletions(-) (limited to 'src/SMAPI/Framework') diff --git a/src/SMAPI/Framework/CommandManager.cs b/src/SMAPI/Framework/CommandManager.cs index aabe99c3..fdaafff1 100644 --- a/src/SMAPI/Framework/CommandManager.cs +++ b/src/SMAPI/Framework/CommandManager.cs @@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework internal class CommandManager { /********* - ** Properties + ** Fields *********/ /// The commands registered with SMAPI. private readonly IDictionary Commands = new Dictionary(StringComparer.InvariantCultureIgnoreCase); diff --git a/src/SMAPI/Framework/Content/AssetData.cs b/src/SMAPI/Framework/Content/AssetData.cs index 0a86f54d..553404d3 100644 --- a/src/SMAPI/Framework/Content/AssetData.cs +++ b/src/SMAPI/Framework/Content/AssetData.cs @@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.Content internal class AssetData : AssetInfo, IAssetData { /********* - ** Properties + ** Fields *********/ /// A callback to invoke when the data is replaced (if any). private readonly Action OnDataReplaced; diff --git a/src/SMAPI/Framework/Content/AssetDataForImage.cs b/src/SMAPI/Framework/Content/AssetDataForImage.cs index f970762a..f2d21b5e 100644 --- a/src/SMAPI/Framework/Content/AssetDataForImage.cs +++ b/src/SMAPI/Framework/Content/AssetDataForImage.cs @@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.Content internal class AssetDataForImage : AssetData, IAssetDataForImage { /********* - ** Properties + ** Fields *********/ /// The minimum value to consider non-transparent. /// On Linux/Mac, fully transparent pixels may have an alpha up to 4 for some reason. diff --git a/src/SMAPI/Framework/Content/AssetInfo.cs b/src/SMAPI/Framework/Content/AssetInfo.cs index d580dc06..e5211290 100644 --- a/src/SMAPI/Framework/Content/AssetInfo.cs +++ b/src/SMAPI/Framework/Content/AssetInfo.cs @@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.Content internal class AssetInfo : IAssetInfo { /********* - ** Properties + ** Fields *********/ /// Normalises an asset key to match the cache key. protected readonly Func GetNormalisedPath; diff --git a/src/SMAPI/Framework/Content/ContentCache.cs b/src/SMAPI/Framework/Content/ContentCache.cs index a5dfac9d..55a96ed2 100644 --- a/src/SMAPI/Framework/Content/ContentCache.cs +++ b/src/SMAPI/Framework/Content/ContentCache.cs @@ -14,7 +14,7 @@ namespace StardewModdingAPI.Framework.Content internal class ContentCache { /********* - ** Properties + ** Fields *********/ /// The underlying asset cache. private readonly IDictionary Cache; diff --git a/src/SMAPI/Framework/ContentCoordinator.cs b/src/SMAPI/Framework/ContentCoordinator.cs index 7e256939..4dd1b6e1 100644 --- a/src/SMAPI/Framework/ContentCoordinator.cs +++ b/src/SMAPI/Framework/ContentCoordinator.cs @@ -19,7 +19,7 @@ namespace StardewModdingAPI.Framework internal class ContentCoordinator : IDisposable { /********* - ** Properties + ** Fields *********/ /// An asset key prefix for assets from SMAPI mod folders. private readonly string ManagedPrefix = "SMAPI"; diff --git a/src/SMAPI/Framework/ContentManagers/BaseContentManager.cs b/src/SMAPI/Framework/ContentManagers/BaseContentManager.cs index 724a6e1c..7821e454 100644 --- a/src/SMAPI/Framework/ContentManagers/BaseContentManager.cs +++ b/src/SMAPI/Framework/ContentManagers/BaseContentManager.cs @@ -18,7 +18,7 @@ namespace StardewModdingAPI.Framework.ContentManagers internal abstract class BaseContentManager : LocalizedContentManager, IContentManager { /********* - ** Properties + ** Fields *********/ /// The central coordinator which manages content managers. protected readonly ContentCoordinator Coordinator; diff --git a/src/SMAPI/Framework/ContentManagers/GameContentManager.cs b/src/SMAPI/Framework/ContentManagers/GameContentManager.cs index 81732d3f..ee940cc7 100644 --- a/src/SMAPI/Framework/ContentManagers/GameContentManager.cs +++ b/src/SMAPI/Framework/ContentManagers/GameContentManager.cs @@ -14,7 +14,7 @@ namespace StardewModdingAPI.Framework.ContentManagers internal class GameContentManager : BaseContentManager { /********* - ** Properties + ** Fields *********/ /// The assets currently being intercepted by instances. This is used to prevent infinite loops when a loader loads a new asset. private readonly ContextHash AssetsBeingLoaded = new ContextHash(); diff --git a/src/SMAPI/Framework/ContentManagers/ModContentManager.cs b/src/SMAPI/Framework/ContentManagers/ModContentManager.cs index ed76a925..6485b3d4 100644 --- a/src/SMAPI/Framework/ContentManagers/ModContentManager.cs +++ b/src/SMAPI/Framework/ContentManagers/ModContentManager.cs @@ -14,7 +14,7 @@ namespace StardewModdingAPI.Framework.ContentManagers internal class ModContentManager : BaseContentManager { /********* - ** Properties + ** Fields *********/ /// Encapsulates SMAPI's JSON file parsing. private readonly JsonHelper JsonHelper; diff --git a/src/SMAPI/Framework/ContentPack.cs b/src/SMAPI/Framework/ContentPack.cs index 49285388..e39d03a1 100644 --- a/src/SMAPI/Framework/ContentPack.cs +++ b/src/SMAPI/Framework/ContentPack.cs @@ -12,7 +12,7 @@ namespace StardewModdingAPI.Framework internal class ContentPack : IContentPack { /********* - ** Properties + ** Fields *********/ /// Provides an API for loading content assets. private readonly IContentHelper Content; diff --git a/src/SMAPI/Framework/DeprecationManager.cs b/src/SMAPI/Framework/DeprecationManager.cs index be564c22..70f88b5e 100644 --- a/src/SMAPI/Framework/DeprecationManager.cs +++ b/src/SMAPI/Framework/DeprecationManager.cs @@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework internal class DeprecationManager { /********* - ** Properties + ** Fields *********/ /// The deprecations which have already been logged (as 'mod name::noun phrase::version'). private readonly HashSet LoggedDeprecations = new HashSet(StringComparer.InvariantCultureIgnoreCase); diff --git a/src/SMAPI/Framework/Events/ManagedEvent.cs b/src/SMAPI/Framework/Events/ManagedEvent.cs index ebd79e6c..f9e7f6ec 100644 --- a/src/SMAPI/Framework/Events/ManagedEvent.cs +++ b/src/SMAPI/Framework/Events/ManagedEvent.cs @@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.Events internal class ManagedEvent : ManagedEventBase> { /********* - ** Properties + ** Fields *********/ /// The underlying event. private event EventHandler Event; @@ -98,7 +98,7 @@ namespace StardewModdingAPI.Framework.Events internal class ManagedEvent : ManagedEventBase { /********* - ** Properties + ** Fields *********/ /// The underlying event. private event EventHandler Event; diff --git a/src/SMAPI/Framework/Events/ManagedEventBase.cs b/src/SMAPI/Framework/Events/ManagedEventBase.cs index defd903a..c8c3516b 100644 --- a/src/SMAPI/Framework/Events/ManagedEventBase.cs +++ b/src/SMAPI/Framework/Events/ManagedEventBase.cs @@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.Events internal abstract class ManagedEventBase { /********* - ** Properties + ** Fields *********/ /// A human-readable name for the event. private readonly string EventName; diff --git a/src/SMAPI/Framework/Events/ModEventsBase.cs b/src/SMAPI/Framework/Events/ModEventsBase.cs index 545c58a8..77708fc1 100644 --- a/src/SMAPI/Framework/Events/ModEventsBase.cs +++ b/src/SMAPI/Framework/Events/ModEventsBase.cs @@ -4,7 +4,7 @@ namespace StardewModdingAPI.Framework.Events internal abstract class ModEventsBase { /********* - ** Properties + ** Fields *********/ /// The underlying event manager. protected readonly EventManager EventManager; diff --git a/src/SMAPI/Framework/Input/GamePadStateBuilder.cs b/src/SMAPI/Framework/Input/GamePadStateBuilder.cs index 33557385..a20e1248 100644 --- a/src/SMAPI/Framework/Input/GamePadStateBuilder.cs +++ b/src/SMAPI/Framework/Input/GamePadStateBuilder.cs @@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.Input internal class GamePadStateBuilder { /********* - ** Properties + ** Fields *********/ /// The current button states. private readonly IDictionary ButtonStates; diff --git a/src/SMAPI/Framework/Logging/ConsoleInterceptionManager.cs b/src/SMAPI/Framework/Logging/ConsoleInterceptionManager.cs index c04bcd1a..ef42e536 100644 --- a/src/SMAPI/Framework/Logging/ConsoleInterceptionManager.cs +++ b/src/SMAPI/Framework/Logging/ConsoleInterceptionManager.cs @@ -6,7 +6,7 @@ namespace StardewModdingAPI.Framework.Logging internal class ConsoleInterceptionManager : IDisposable { /********* - ** Properties + ** Fields *********/ /// The intercepting console writer. private readonly InterceptingTextWriter Output; diff --git a/src/SMAPI/Framework/Logging/LogFileManager.cs b/src/SMAPI/Framework/Logging/LogFileManager.cs index 8cfe0527..6b5babcd 100644 --- a/src/SMAPI/Framework/Logging/LogFileManager.cs +++ b/src/SMAPI/Framework/Logging/LogFileManager.cs @@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.Logging internal class LogFileManager : IDisposable { /********* - ** Properties + ** Fields *********/ /// The underlying stream writer. private readonly StreamWriter Stream; diff --git a/src/SMAPI/Framework/ModHelpers/CommandHelper.cs b/src/SMAPI/Framework/ModHelpers/CommandHelper.cs index a4fd21c1..e9d53d84 100644 --- a/src/SMAPI/Framework/ModHelpers/CommandHelper.cs +++ b/src/SMAPI/Framework/ModHelpers/CommandHelper.cs @@ -6,7 +6,7 @@ namespace StardewModdingAPI.Framework.ModHelpers internal class CommandHelper : BaseHelper, ICommandHelper { /********* - ** Properties + ** Fields *********/ /// The mod using this instance. private readonly IModMetadata Mod; diff --git a/src/SMAPI/Framework/ModHelpers/ContentHelper.cs b/src/SMAPI/Framework/ModHelpers/ContentHelper.cs index a8b24a13..dac627ba 100644 --- a/src/SMAPI/Framework/ModHelpers/ContentHelper.cs +++ b/src/SMAPI/Framework/ModHelpers/ContentHelper.cs @@ -21,7 +21,7 @@ namespace StardewModdingAPI.Framework.ModHelpers internal class ContentHelper : BaseHelper, IContentHelper { /********* - ** Properties + ** Fields *********/ /// SMAPI's core content logic. private readonly ContentCoordinator ContentCore; diff --git a/src/SMAPI/Framework/ModHelpers/ContentPackHelper.cs b/src/SMAPI/Framework/ModHelpers/ContentPackHelper.cs index 26c4648c..34f24d65 100644 --- a/src/SMAPI/Framework/ModHelpers/ContentPackHelper.cs +++ b/src/SMAPI/Framework/ModHelpers/ContentPackHelper.cs @@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModHelpers internal class ContentPackHelper : BaseHelper, IContentPackHelper { /********* - ** Properties + ** Fields *********/ /// The content packs loaded for this mod. private readonly Lazy ContentPacks; diff --git a/src/SMAPI/Framework/ModHelpers/DataHelper.cs b/src/SMAPI/Framework/ModHelpers/DataHelper.cs index 242b8ab1..2cb886ba 100644 --- a/src/SMAPI/Framework/ModHelpers/DataHelper.cs +++ b/src/SMAPI/Framework/ModHelpers/DataHelper.cs @@ -11,7 +11,7 @@ namespace StardewModdingAPI.Framework.ModHelpers internal class DataHelper : BaseHelper, IDataHelper { /********* - ** Properties + ** Fields *********/ /// Encapsulates SMAPI's JSON file parsing. private readonly JsonHelper JsonHelper; diff --git a/src/SMAPI/Framework/ModHelpers/ModRegistryHelper.cs b/src/SMAPI/Framework/ModHelpers/ModRegistryHelper.cs index 5cc2a20f..8330e078 100644 --- a/src/SMAPI/Framework/ModHelpers/ModRegistryHelper.cs +++ b/src/SMAPI/Framework/ModHelpers/ModRegistryHelper.cs @@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.ModHelpers internal class ModRegistryHelper : BaseHelper, IModRegistry { /********* - ** Properties + ** Fields *********/ /// The underlying mod registry. private readonly ModRegistry Registry; diff --git a/src/SMAPI/Framework/ModHelpers/MultiplayerHelper.cs b/src/SMAPI/Framework/ModHelpers/MultiplayerHelper.cs index eedad0bc..c62dd121 100644 --- a/src/SMAPI/Framework/ModHelpers/MultiplayerHelper.cs +++ b/src/SMAPI/Framework/ModHelpers/MultiplayerHelper.cs @@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModHelpers internal class MultiplayerHelper : BaseHelper, IMultiplayerHelper { /********* - ** Properties + ** Fields *********/ /// SMAPI's core multiplayer utility. private readonly SMultiplayer Multiplayer; diff --git a/src/SMAPI/Framework/ModHelpers/ReflectionHelper.cs b/src/SMAPI/Framework/ModHelpers/ReflectionHelper.cs index cfe2ddbe..0ce72a9e 100644 --- a/src/SMAPI/Framework/ModHelpers/ReflectionHelper.cs +++ b/src/SMAPI/Framework/ModHelpers/ReflectionHelper.cs @@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModHelpers internal class ReflectionHelper : BaseHelper, IReflectionHelper { /********* - ** Properties + ** Fields *********/ /// The underlying reflection helper. private readonly Reflector Reflector; diff --git a/src/SMAPI/Framework/ModHelpers/TranslationHelper.cs b/src/SMAPI/Framework/ModHelpers/TranslationHelper.cs index bbe3a81a..3252e047 100644 --- a/src/SMAPI/Framework/ModHelpers/TranslationHelper.cs +++ b/src/SMAPI/Framework/ModHelpers/TranslationHelper.cs @@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModHelpers internal class TranslationHelper : BaseHelper, ITranslationHelper { /********* - ** Properties + ** Fields *********/ /// The name of the relevant mod for error messages. private readonly string ModName; diff --git a/src/SMAPI/Framework/ModLoading/AssemblyDefinitionResolver.cs b/src/SMAPI/Framework/ModLoading/AssemblyDefinitionResolver.cs index 91c9e192..aefb0126 100644 --- a/src/SMAPI/Framework/ModLoading/AssemblyDefinitionResolver.cs +++ b/src/SMAPI/Framework/ModLoading/AssemblyDefinitionResolver.cs @@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading internal class AssemblyDefinitionResolver : DefaultAssemblyResolver { /********* - ** Properties + ** Fields *********/ /// The known assemblies. private readonly IDictionary Lookup = new Dictionary(); diff --git a/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs b/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs index 7292cf3f..5e0571a0 100644 --- a/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs +++ b/src/SMAPI/Framework/ModLoading/AssemblyLoader.cs @@ -15,7 +15,7 @@ namespace StardewModdingAPI.Framework.ModLoading internal class AssemblyLoader : IDisposable { /********* - ** Properties + ** Fields *********/ /// Encapsulates monitoring and logging. private readonly IMonitor Monitor; diff --git a/src/SMAPI/Framework/ModLoading/Finders/EventFinder.cs b/src/SMAPI/Framework/ModLoading/Finders/EventFinder.cs index e4beb7a9..898bafb4 100644 --- a/src/SMAPI/Framework/ModLoading/Finders/EventFinder.cs +++ b/src/SMAPI/Framework/ModLoading/Finders/EventFinder.cs @@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders internal class EventFinder : IInstructionHandler { /********* - ** Properties + ** Fields *********/ /// The full type name for which to find references. private readonly string FullTypeName; diff --git a/src/SMAPI/Framework/ModLoading/Finders/FieldFinder.cs b/src/SMAPI/Framework/ModLoading/Finders/FieldFinder.cs index 00805815..606ca8b7 100644 --- a/src/SMAPI/Framework/ModLoading/Finders/FieldFinder.cs +++ b/src/SMAPI/Framework/ModLoading/Finders/FieldFinder.cs @@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders internal class FieldFinder : IInstructionHandler { /********* - ** Properties + ** Fields *********/ /// The full type name for which to find references. private readonly string FullTypeName; diff --git a/src/SMAPI/Framework/ModLoading/Finders/MethodFinder.cs b/src/SMAPI/Framework/ModLoading/Finders/MethodFinder.cs index 5358f181..9ca246ff 100644 --- a/src/SMAPI/Framework/ModLoading/Finders/MethodFinder.cs +++ b/src/SMAPI/Framework/ModLoading/Finders/MethodFinder.cs @@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders internal class MethodFinder : IInstructionHandler { /********* - ** Properties + ** Fields *********/ /// The full type name for which to find references. private readonly string FullTypeName; diff --git a/src/SMAPI/Framework/ModLoading/Finders/PropertyFinder.cs b/src/SMAPI/Framework/ModLoading/Finders/PropertyFinder.cs index e54c86cf..0677aa88 100644 --- a/src/SMAPI/Framework/ModLoading/Finders/PropertyFinder.cs +++ b/src/SMAPI/Framework/ModLoading/Finders/PropertyFinder.cs @@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders internal class PropertyFinder : IInstructionHandler { /********* - ** Properties + ** Fields *********/ /// The full type name for which to find references. private readonly string FullTypeName; diff --git a/src/SMAPI/Framework/ModLoading/Finders/ReferenceToMemberWithUnexpectedTypeFinder.cs b/src/SMAPI/Framework/ModLoading/Finders/ReferenceToMemberWithUnexpectedTypeFinder.cs index 3a26660f..82c4920a 100644 --- a/src/SMAPI/Framework/ModLoading/Finders/ReferenceToMemberWithUnexpectedTypeFinder.cs +++ b/src/SMAPI/Framework/ModLoading/Finders/ReferenceToMemberWithUnexpectedTypeFinder.cs @@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders internal class ReferenceToMemberWithUnexpectedTypeFinder : IInstructionHandler { /********* - ** Properties + ** Fields *********/ /// The assembly names to which to heuristically detect broken references. private readonly HashSet ValidateReferencesToAssemblies; diff --git a/src/SMAPI/Framework/ModLoading/Finders/ReferenceToMissingMemberFinder.cs b/src/SMAPI/Framework/ModLoading/Finders/ReferenceToMissingMemberFinder.cs index b95dd79c..44b531a5 100644 --- a/src/SMAPI/Framework/ModLoading/Finders/ReferenceToMissingMemberFinder.cs +++ b/src/SMAPI/Framework/ModLoading/Finders/ReferenceToMissingMemberFinder.cs @@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Finders internal class ReferenceToMissingMemberFinder : IInstructionHandler { /********* - ** Properties + ** Fields *********/ /// The assembly names to which to heuristically detect broken references. private readonly HashSet ValidateReferencesToAssemblies; diff --git a/src/SMAPI/Framework/ModLoading/RewriteHelper.cs b/src/SMAPI/Framework/ModLoading/RewriteHelper.cs index 9ff43d45..f8f10dc4 100644 --- a/src/SMAPI/Framework/ModLoading/RewriteHelper.cs +++ b/src/SMAPI/Framework/ModLoading/RewriteHelper.cs @@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading internal static class RewriteHelper { /********* - ** Properties + ** Fields *********/ /// The comparer which heuristically compares type definitions. private static readonly TypeReferenceComparer TypeDefinitionComparer = new TypeReferenceComparer(); diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs index 806a074f..ff86c6e2 100644 --- a/src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs +++ b/src/SMAPI/Framework/ModLoading/Rewriters/FieldReplaceRewriter.cs @@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters internal class FieldReplaceRewriter : FieldFinder { /********* - ** Properties + ** Fields *********/ /// The new field to reference. private readonly FieldInfo ToField; diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/FieldToPropertyRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/FieldToPropertyRewriter.cs index e6ede9e3..a43c5e9a 100644 --- a/src/SMAPI/Framework/ModLoading/Rewriters/FieldToPropertyRewriter.cs +++ b/src/SMAPI/Framework/ModLoading/Rewriters/FieldToPropertyRewriter.cs @@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters internal class FieldToPropertyRewriter : FieldFinder { /********* - ** Properties + ** Fields *********/ /// The type whose field to which references should be rewritten. private readonly Type Type; diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs index 99bd9125..6b8c2de1 100644 --- a/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs +++ b/src/SMAPI/Framework/ModLoading/Rewriters/MethodParentRewriter.cs @@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters internal class MethodParentRewriter : IInstructionHandler { /********* - ** Properties + ** Fields *********/ /// The type whose methods to remap. private readonly Type FromType; diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/StaticFieldToConstantRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/StaticFieldToConstantRewriter.cs index 5e12b46a..7e7c0efa 100644 --- a/src/SMAPI/Framework/ModLoading/Rewriters/StaticFieldToConstantRewriter.cs +++ b/src/SMAPI/Framework/ModLoading/Rewriters/StaticFieldToConstantRewriter.cs @@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters internal class StaticFieldToConstantRewriter : FieldFinder { /********* - ** Properties + ** Fields *********/ /// The constant value to replace with. private readonly TValue Value; diff --git a/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs b/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs index 62e15731..fade082b 100644 --- a/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs +++ b/src/SMAPI/Framework/ModLoading/Rewriters/TypeReferenceRewriter.cs @@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.ModLoading.Rewriters internal class TypeReferenceRewriter : TypeFinder { /********* - ** Properties + ** Fields *********/ /// The full type name to which to find references. private readonly string FromTypeName; diff --git a/src/SMAPI/Framework/ModRegistry.cs b/src/SMAPI/Framework/ModRegistry.cs index 8ce3172c..e9ceb66e 100644 --- a/src/SMAPI/Framework/ModRegistry.cs +++ b/src/SMAPI/Framework/ModRegistry.cs @@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework internal class ModRegistry { /********* - ** Properties + ** Fields *********/ /// The registered mod data. private readonly List Mods = new List(); diff --git a/src/SMAPI/Framework/Monitor.cs b/src/SMAPI/Framework/Monitor.cs index a4d92e4b..47ebc2d7 100644 --- a/src/SMAPI/Framework/Monitor.cs +++ b/src/SMAPI/Framework/Monitor.cs @@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework internal class Monitor : IMonitor { /********* - ** Properties + ** Fields *********/ /// The name of the module which logs messages using this instance. private readonly string Source; diff --git a/src/SMAPI/Framework/Networking/MultiplayerPeer.cs b/src/SMAPI/Framework/Networking/MultiplayerPeer.cs index 44a71978..b4e39379 100644 --- a/src/SMAPI/Framework/Networking/MultiplayerPeer.cs +++ b/src/SMAPI/Framework/Networking/MultiplayerPeer.cs @@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.Networking internal class MultiplayerPeer : IMultiplayerPeer { /********* - ** Properties + ** Fields *********/ /// A method which sends a message to the peer. private readonly Action SendMessageImpl; diff --git a/src/SMAPI/Framework/Networking/SGalaxyNetClient.cs b/src/SMAPI/Framework/Networking/SGalaxyNetClient.cs index fddd423d..01095c66 100644 --- a/src/SMAPI/Framework/Networking/SGalaxyNetClient.cs +++ b/src/SMAPI/Framework/Networking/SGalaxyNetClient.cs @@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.Networking internal class SGalaxyNetClient : GalaxyNetClient { /********* - ** Properties + ** Fields *********/ /// A callback to raise when receiving a message. This receives the incoming message, a method to send an arbitrary message, and a callback to run the default logic. private readonly Action, Action> OnProcessingMessage; diff --git a/src/SMAPI/Framework/Networking/SGalaxyNetServer.cs b/src/SMAPI/Framework/Networking/SGalaxyNetServer.cs index 82d11938..bb67f70e 100644 --- a/src/SMAPI/Framework/Networking/SGalaxyNetServer.cs +++ b/src/SMAPI/Framework/Networking/SGalaxyNetServer.cs @@ -11,7 +11,7 @@ namespace StardewModdingAPI.Framework.Networking internal class SGalaxyNetServer : GalaxyNetServer { /********* - ** Properties + ** Fields *********/ /// A callback to raise when receiving a message. This receives the incoming message, a method to send a message, and a callback to run the default logic. private readonly Action, Action> OnProcessingMessage; diff --git a/src/SMAPI/Framework/Networking/SLidgrenClient.cs b/src/SMAPI/Framework/Networking/SLidgrenClient.cs index 02d9d68f..39876744 100644 --- a/src/SMAPI/Framework/Networking/SLidgrenClient.cs +++ b/src/SMAPI/Framework/Networking/SLidgrenClient.cs @@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.Networking internal class SLidgrenClient : LidgrenClient { /********* - ** Properties + ** Fields *********/ /// A callback to raise when receiving a message. This receives the incoming message, a method to send an arbitrary message, and a callback to run the default logic. private readonly Action, Action> OnProcessingMessage; diff --git a/src/SMAPI/Framework/Networking/SLidgrenServer.cs b/src/SMAPI/Framework/Networking/SLidgrenServer.cs index 251e5268..1bce47fe 100644 --- a/src/SMAPI/Framework/Networking/SLidgrenServer.cs +++ b/src/SMAPI/Framework/Networking/SLidgrenServer.cs @@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.Networking internal class SLidgrenServer : LidgrenServer { /********* - ** Properties + ** Fields *********/ /// SMAPI's implementation of the game's core multiplayer logic. private readonly SMultiplayer Multiplayer; diff --git a/src/SMAPI/Framework/Patching/GamePatcher.cs b/src/SMAPI/Framework/Patching/GamePatcher.cs index 71ca8e55..f82159d0 100644 --- a/src/SMAPI/Framework/Patching/GamePatcher.cs +++ b/src/SMAPI/Framework/Patching/GamePatcher.cs @@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.Patching internal class GamePatcher { /********* - ** Properties + ** Fields *********/ /// Encapsulates monitoring and logging. private readonly IMonitor Monitor; diff --git a/src/SMAPI/Framework/Reflection/InterfaceProxyBuilder.cs b/src/SMAPI/Framework/Reflection/InterfaceProxyBuilder.cs index 7a2958fb..70ef81f8 100644 --- a/src/SMAPI/Framework/Reflection/InterfaceProxyBuilder.cs +++ b/src/SMAPI/Framework/Reflection/InterfaceProxyBuilder.cs @@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.Reflection internal class InterfaceProxyBuilder { /********* - ** Properties + ** Fields *********/ /// The target class type. private readonly Type TargetType; diff --git a/src/SMAPI/Framework/Reflection/InterfaceProxyFactory.cs b/src/SMAPI/Framework/Reflection/InterfaceProxyFactory.cs index e14a9f08..464367b6 100644 --- a/src/SMAPI/Framework/Reflection/InterfaceProxyFactory.cs +++ b/src/SMAPI/Framework/Reflection/InterfaceProxyFactory.cs @@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.Reflection internal class InterfaceProxyFactory { /********* - ** Properties + ** Fields *********/ /// The CLR module in which to create proxy classes. private readonly ModuleBuilder ModuleBuilder; diff --git a/src/SMAPI/Framework/Reflection/ReflectedField.cs b/src/SMAPI/Framework/Reflection/ReflectedField.cs index 09638b1d..d771422c 100644 --- a/src/SMAPI/Framework/Reflection/ReflectedField.cs +++ b/src/SMAPI/Framework/Reflection/ReflectedField.cs @@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.Reflection internal class ReflectedField : IReflectedField { /********* - ** Properties + ** Fields *********/ /// The type that has the field. private readonly Type ParentType; diff --git a/src/SMAPI/Framework/Reflection/ReflectedMethod.cs b/src/SMAPI/Framework/Reflection/ReflectedMethod.cs index 7d9072a0..039f27c3 100644 --- a/src/SMAPI/Framework/Reflection/ReflectedMethod.cs +++ b/src/SMAPI/Framework/Reflection/ReflectedMethod.cs @@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework.Reflection internal class ReflectedMethod : IReflectedMethod { /********* - ** Properties + ** Fields *********/ /// The type that has the method. private readonly Type ParentType; diff --git a/src/SMAPI/Framework/Reflection/ReflectedProperty.cs b/src/SMAPI/Framework/Reflection/ReflectedProperty.cs index d59b71ac..8a10ff9a 100644 --- a/src/SMAPI/Framework/Reflection/ReflectedProperty.cs +++ b/src/SMAPI/Framework/Reflection/ReflectedProperty.cs @@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.Reflection internal class ReflectedProperty : IReflectedProperty { /********* - ** Properties + ** Fields *********/ /// The display name shown in error messages. private readonly string DisplayName; diff --git a/src/SMAPI/Framework/Reflection/Reflector.cs b/src/SMAPI/Framework/Reflection/Reflector.cs index 910e3a54..ed1a4381 100644 --- a/src/SMAPI/Framework/Reflection/Reflector.cs +++ b/src/SMAPI/Framework/Reflection/Reflector.cs @@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.Reflection internal class Reflector { /********* - ** Properties + ** Fields *********/ /// The cached fields and methods found via reflection. private readonly MemoryCache Cache = new MemoryCache(typeof(Reflector).FullName); diff --git a/src/SMAPI/Framework/SCore.cs b/src/SMAPI/Framework/SCore.cs index 00801b72..6df94ad4 100644 --- a/src/SMAPI/Framework/SCore.cs +++ b/src/SMAPI/Framework/SCore.cs @@ -42,7 +42,7 @@ namespace StardewModdingAPI.Framework internal class SCore : IDisposable { /********* - ** Properties + ** Fields *********/ /// The log file to which to write messages. private readonly LogFileManager LogFile; diff --git a/src/SMAPI/Framework/SGame.cs b/src/SMAPI/Framework/SGame.cs index 957fd1d6..e2835a70 100644 --- a/src/SMAPI/Framework/SGame.cs +++ b/src/SMAPI/Framework/SGame.cs @@ -39,7 +39,7 @@ namespace StardewModdingAPI.Framework internal class SGame : Game1 { /********* - ** Properties + ** Fields *********/ /**** ** SMAPI state diff --git a/src/SMAPI/Framework/SModHooks.cs b/src/SMAPI/Framework/SModHooks.cs index 9f0201c8..7dafc746 100644 --- a/src/SMAPI/Framework/SModHooks.cs +++ b/src/SMAPI/Framework/SModHooks.cs @@ -7,7 +7,7 @@ namespace StardewModdingAPI.Framework internal class SModHooks : ModHooks { /********* - ** Properties + ** Fields *********/ /// A callback to invoke before runs. private readonly Action BeforeNewDayAfterFade; diff --git a/src/SMAPI/Framework/SMultiplayer.cs b/src/SMAPI/Framework/SMultiplayer.cs index 29d9b2b8..0241ef02 100644 --- a/src/SMAPI/Framework/SMultiplayer.cs +++ b/src/SMAPI/Framework/SMultiplayer.cs @@ -31,7 +31,7 @@ namespace StardewModdingAPI.Framework internal class SMultiplayer : Multiplayer { /********* - ** Properties + ** Fields *********/ /// Encapsulates monitoring and logging. private readonly IMonitor Monitor; diff --git a/src/SMAPI/Framework/StateTracking/FieldWatchers/BaseDisposableWatcher.cs b/src/SMAPI/Framework/StateTracking/FieldWatchers/BaseDisposableWatcher.cs index 40ec6c57..60006c51 100644 --- a/src/SMAPI/Framework/StateTracking/FieldWatchers/BaseDisposableWatcher.cs +++ b/src/SMAPI/Framework/StateTracking/FieldWatchers/BaseDisposableWatcher.cs @@ -6,7 +6,7 @@ namespace StardewModdingAPI.Framework.StateTracking.FieldWatchers internal abstract class BaseDisposableWatcher : IDisposable { /********* - ** Properties + ** Fields *********/ /// Whether the watcher has been disposed. protected bool IsDisposed { get; private set; } diff --git a/src/SMAPI/Framework/StateTracking/FieldWatchers/ComparableListWatcher.cs b/src/SMAPI/Framework/StateTracking/FieldWatchers/ComparableListWatcher.cs index 2ea6609a..6550f950 100644 --- a/src/SMAPI/Framework/StateTracking/FieldWatchers/ComparableListWatcher.cs +++ b/src/SMAPI/Framework/StateTracking/FieldWatchers/ComparableListWatcher.cs @@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.StateTracking.FieldWatchers internal class ComparableListWatcher : BaseDisposableWatcher, ICollectionWatcher { /********* - ** Properties + ** Fields *********/ /// The collection to watch. private readonly ICollection CurrentValues; diff --git a/src/SMAPI/Framework/StateTracking/FieldWatchers/ComparableWatcher.cs b/src/SMAPI/Framework/StateTracking/FieldWatchers/ComparableWatcher.cs index dda30a15..5ca4b9f4 100644 --- a/src/SMAPI/Framework/StateTracking/FieldWatchers/ComparableWatcher.cs +++ b/src/SMAPI/Framework/StateTracking/FieldWatchers/ComparableWatcher.cs @@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.StateTracking.FieldWatchers internal class ComparableWatcher : IValueWatcher { /********* - ** Properties + ** Fields *********/ /// Get the current value. private readonly Func GetValue; diff --git a/src/SMAPI/Framework/StateTracking/FieldWatchers/NetCollectionWatcher.cs b/src/SMAPI/Framework/StateTracking/FieldWatchers/NetCollectionWatcher.cs index d3022a69..21e84c47 100644 --- a/src/SMAPI/Framework/StateTracking/FieldWatchers/NetCollectionWatcher.cs +++ b/src/SMAPI/Framework/StateTracking/FieldWatchers/NetCollectionWatcher.cs @@ -9,7 +9,7 @@ namespace StardewModdingAPI.Framework.StateTracking.FieldWatchers where TValue : class, INetObject { /********* - ** Properties + ** Fields *********/ /// The field being watched. private readonly NetCollection Field; diff --git a/src/SMAPI/Framework/StateTracking/FieldWatchers/NetDictionaryWatcher.cs b/src/SMAPI/Framework/StateTracking/FieldWatchers/NetDictionaryWatcher.cs index 7a7ab89d..e6882f7e 100644 --- a/src/SMAPI/Framework/StateTracking/FieldWatchers/NetDictionaryWatcher.cs +++ b/src/SMAPI/Framework/StateTracking/FieldWatchers/NetDictionaryWatcher.cs @@ -15,7 +15,7 @@ namespace StardewModdingAPI.Framework.StateTracking.FieldWatchers where TSelf : NetDictionary { /********* - ** Properties + ** Fields *********/ /// The pairs added since the last reset. private readonly IDictionary PairsAdded = new Dictionary(); diff --git a/src/SMAPI/Framework/StateTracking/FieldWatchers/NetValueWatcher.cs b/src/SMAPI/Framework/StateTracking/FieldWatchers/NetValueWatcher.cs index 85099988..48d5d681 100644 --- a/src/SMAPI/Framework/StateTracking/FieldWatchers/NetValueWatcher.cs +++ b/src/SMAPI/Framework/StateTracking/FieldWatchers/NetValueWatcher.cs @@ -8,7 +8,7 @@ namespace StardewModdingAPI.Framework.StateTracking.FieldWatchers internal class NetValueWatcher : BaseDisposableWatcher, IValueWatcher where TNetField : NetFieldBase { /********* - ** Properties + ** Fields *********/ /// The field being watched. private readonly NetFieldBase Field; diff --git a/src/SMAPI/Framework/StateTracking/FieldWatchers/ObservableCollectionWatcher.cs b/src/SMAPI/Framework/StateTracking/FieldWatchers/ObservableCollectionWatcher.cs index 0c65789f..883b1023 100644 --- a/src/SMAPI/Framework/StateTracking/FieldWatchers/ObservableCollectionWatcher.cs +++ b/src/SMAPI/Framework/StateTracking/FieldWatchers/ObservableCollectionWatcher.cs @@ -10,7 +10,7 @@ namespace StardewModdingAPI.Framework.StateTracking.FieldWatchers internal class ObservableCollectionWatcher : BaseDisposableWatcher, ICollectionWatcher { /********* - ** Properties + ** Fields *********/ /// The field being watched. private readonly ObservableCollection Field; diff --git a/src/SMAPI/Framework/StateTracking/LocationTracker.cs b/src/SMAPI/Framework/StateTracking/LocationTracker.cs index 708c0716..2249e41b 100644 --- a/src/SMAPI/Framework/StateTracking/LocationTracker.cs +++ b/src/SMAPI/Framework/StateTracking/LocationTracker.cs @@ -15,7 +15,7 @@ namespace StardewModdingAPI.Framework.StateTracking internal class LocationTracker : IWatcher { /********* - ** Properties + ** Fields *********/ /// The underlying watchers. private readonly List Watchers = new List(); diff --git a/src/SMAPI/Framework/StateTracking/PlayerTracker.cs b/src/SMAPI/Framework/StateTracking/PlayerTracker.cs index 6a705e50..abb4fa24 100644 --- a/src/SMAPI/Framework/StateTracking/PlayerTracker.cs +++ b/src/SMAPI/Framework/StateTracking/PlayerTracker.cs @@ -14,7 +14,7 @@ namespace StardewModdingAPI.Framework.StateTracking internal class PlayerTracker : IDisposable { /********* - ** Properties + ** Fields *********/ /// The player's inventory as of the last reset. private IDictionary PreviousInventory; diff --git a/src/SMAPI/Framework/StateTracking/WorldLocationsTracker.cs b/src/SMAPI/Framework/StateTracking/WorldLocationsTracker.cs index 930a8102..f09c69c1 100644 --- a/src/SMAPI/Framework/StateTracking/WorldLocationsTracker.cs +++ b/src/SMAPI/Framework/StateTracking/WorldLocationsTracker.cs @@ -13,7 +13,7 @@ namespace StardewModdingAPI.Framework.StateTracking internal class WorldLocationsTracker : IWatcher { /********* - ** Properties + ** Fields *********/ /// Tracks changes to the location list. private readonly ICollectionWatcher LocationListWatcher; diff --git a/src/SMAPI/Framework/WatcherCore.cs b/src/SMAPI/Framework/WatcherCore.cs index 8d29cf18..32b7fdc6 100644 --- a/src/SMAPI/Framework/WatcherCore.cs +++ b/src/SMAPI/Framework/WatcherCore.cs @@ -14,7 +14,7 @@ namespace StardewModdingAPI.Framework internal class WatcherCore { /********* - ** Properties + ** Fields *********/ /// The underlying watchers for convenience. These are accessible individually as separate properties. private readonly List Watchers = new List(); -- cgit