diff options
| author | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2018-12-27 12:39:10 -0500 |
|---|---|---|
| committer | Jesse Plamondon-Willard <Pathoschild@users.noreply.github.com> | 2018-12-27 12:39:10 -0500 |
| commit | c4a82418ac8b09a6965052f5c9173928457fba52 (patch) | |
| tree | a17f53fb9e9a3c54089b1d28a4c04f94d2ec0b80 /src/SMAPI/Framework | |
| parent | 51e65fc8a090996b0bb2f0f4697376135b233654 (diff) | |
| download | SMAPI-c4a82418ac8b09a6965052f5c9173928457fba52.tar.gz SMAPI-c4a82418ac8b09a6965052f5c9173928457fba52.tar.bz2 SMAPI-c4a82418ac8b09a6965052f5c9173928457fba52.zip | |
tweak comment header convention
Diffstat (limited to 'src/SMAPI/Framework')
68 files changed, 69 insertions, 69 deletions
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 *********/ /// <summary>The commands registered with SMAPI.</summary> private readonly IDictionary<string, Command> Commands = new Dictionary<string, Command>(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<TValue> : AssetInfo, IAssetData<TValue> { /********* - ** Properties + ** Fields *********/ /// <summary>A callback to invoke when the data is replaced (if any).</summary> private readonly Action<TValue> 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<Texture2D>, IAssetDataForImage { /********* - ** Properties + ** Fields *********/ /// <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> 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 *********/ /// <summary>Normalises an asset key to match the cache key.</summary> protected readonly Func<string, string> 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 *********/ /// <summary>The underlying asset cache.</summary> private readonly IDictionary<string, object> 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 *********/ /// <summary>An asset key prefix for assets from SMAPI mod folders.</summary> 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 *********/ /// <summary>The central coordinator which manages content managers.</summary> 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 *********/ /// <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>(); 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 *********/ /// <summary>Encapsulates SMAPI's JSON file parsing.</summary> 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 *********/ /// <summary>Provides an API for loading content assets.</summary> 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 *********/ /// <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); 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<TEventArgs> : ManagedEventBase<EventHandler<TEventArgs>> { /********* - ** Properties + ** Fields *********/ /// <summary>The underlying event.</summary> private event EventHandler<TEventArgs> Event; @@ -98,7 +98,7 @@ namespace StardewModdingAPI.Framework.Events internal class ManagedEvent : ManagedEventBase<EventHandler> { /********* - ** Properties + ** Fields *********/ /// <summary>The underlying event.</summary> 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<TEventHandler> { /********* - ** Properties + ** Fields *********/ /// <summary>A human-readable name for the event.</summary> 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 *********/ /// <summary>The underlying event manager.</summary> 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 *********/ /// <summary>The current button states.</summary> private readonly IDictionary<SButton, ButtonState> 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 *********/ /// <summary>The intercepting console writer.</summary> 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 *********/ /// <summary>The underlying stream writer.</summary> 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 *********/ /// <summary>The mod using this instance.</summary> 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 *********/ /// <summary>SMAPI's core content logic.</summary> 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 *********/ /// <summary>The content packs loaded for this mod.</summary> private readonly Lazy<IContentPack[]> 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 *********/ /// <summary>Encapsulates SMAPI's JSON file parsing.</summary> 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 *********/ /// <summary>The underlying mod registry.</summary> 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 *********/ /// <summary>SMAPI's core multiplayer utility.</summary> 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< |
