From 6e486d0cea4d6578657c918b8dde9268569b1e1a Mon Sep 17 00:00:00 2001 From: goat Date: Fri, 14 Feb 2020 17:56:46 +0900 Subject: [PATCH] docs: document Framework subsystems --- Dalamud/Game/Internal/Framework.cs | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/Dalamud/Game/Internal/Framework.cs b/Dalamud/Game/Internal/Framework.cs index 119b9b2dc..1fd8cc62a 100644 --- a/Dalamud/Game/Internal/Framework.cs +++ b/Dalamud/Game/Internal/Framework.cs @@ -8,6 +8,9 @@ using Serilog; using Dalamud.Game.Internal.File; namespace Dalamud.Game.Internal { + /// + /// This class represents the Framework of the native game client and grants access to various subsystems. + /// public sealed class Framework : IDisposable { [UnmanagedFunctionPointer(CallingConvention.ThisCall)] private delegate bool OnUpdateDetour(IntPtr framework); @@ -25,12 +28,18 @@ namespace Dalamud.Game.Internal { private FrameworkAddressResolver Address { get; } #region Subsystems - + + /// + /// The GUI subsystem, used to access e.g. chat. + /// public GameGui Gui { get; private set; } + /// + /// The Network subsystem, used to access network data. + /// public GameNetwork Network { get; private set; } - public ResourceManager Resource { get; private set; } + //public ResourceManager Resource { get; private set; } public LibcFunction Libc { get; private set; }