Documentation completed

falahati · Aug 10, 2017 · 053bae1 · 053bae1
1 parent bda6ff6
commit 053bae1
Show file tree

Hide file tree

Showing 4 changed files with 60 additions and 3 deletions.
diff --git a/NvAPIWrapper/Native/GPU/Structures/DynamicPerformanceStatesInfo.cs b/NvAPIWrapper/Native/GPU/Structures/DynamicPerformanceStatesInfo.cs
@@ -13,14 +13,17 @@ namespace NvAPIWrapper.Native.GPU.Structures
     [StructureVersion(1)]
     public struct DynamicPerformanceStatesInfo : IInitializable
     {
-        public const int MaxGpuUtilizations = 8;
+        internal const int MaxGpuUtilizations = 8;
 
         internal StructureVersion _Version;
         internal readonly uint _Flags;
 
         [MarshalAs(UnmanagedType.ByValArray, SizeConst = MaxGpuUtilizations)] internal
             DynamicPerformanceStateUtilizationDomainInfo[] UtilizationDomain;
 
+        /// <summary>
+        ///     Gets a boolean value indicating if the dynamic performance state is enabled
+        /// </summary>
         public bool IsDynamicPerformanceStateEnabled => _Flags.GetBit(0);
 
         /// Graphic engine (GPU) utilization

diff --git a/NvAPIWrapper/Native/GPU/Structures/ThermalSettingsV1.cs b/NvAPIWrapper/Native/GPU/Structures/ThermalSettingsV1.cs
@@ -14,7 +14,7 @@ namespace NvAPIWrapper.Native.GPU.Structures
     [StructureVersion(1)]
     public struct ThermalSettingsV1 : IInitializable, IThermalSettings
     {
-        public const int MaxThermalSensorsPerGPU = 3;
+        internal const int MaxThermalSensorsPerGPU = 3;
 
         internal StructureVersion _Version;
         internal readonly uint _Count;

diff --git a/NvAPIWrapper/Native/GPU/ThermalSettingsController.cs b/NvAPIWrapper/Native/GPU/ThermalSettingsController.cs
@@ -5,18 +5,69 @@
     /// </summary>
     public enum ThermalSettingsController
     {
+        /// <summary>
+        ///     No Thermal Controller
+        /// </summary>
         None = 0,
+
+        /// <summary>
+        ///     GPU acting as thermal controller
+        /// </summary>
         GPU,
+
+        /// <summary>
+        ///     ADM1032 Thermal Controller
+        /// </summary>
         ADM1032,
+
+        /// <summary>
+        ///     MAX6649 Thermal Controller
+        /// </summary>
         MAX6649,
+
+        /// <summary>
+        ///     MAX1617 Thermal Controller
+        /// </summary>
         MAX1617,
+
+        /// <summary>
+        ///     LM99 Thermal Controller
+        /// </summary>
         LM99,
+
+        /// <summary>
+        ///     LM89 Thermal Controller
+        /// </summary>
         LM89,
+
+        /// <summary>
+        ///     LM64 Thermal Controller
+        /// </summary>
         LM64,
+
+        /// <summary>
+        ///     ADT7473 Thermal Controller
+        /// </summary>
         ADT7473,
+
+        /// <summary>
+        ///     SBMAX6649 Thermal Controller
+        /// </summary>
         SBMAX6649,
+
+        /// <summary>
+        ///     VideoBios acting as thermal controller
+        /// </summary>
         VideoBiosEvent,
+
+        /// <summary>
+        ///     Operating System acting as thermal controller
+        /// </summary>
         OperatingSystem,
+
+        /// <summary>
+        ///     Unknown Thermal Controller
+        /// </summary>
         Unknown = -1
     }
 }
diff --git a/NvAPIWrapper/Native/GPU/ThermalSettingsTarget.cs b/NvAPIWrapper/Native/GPU/ThermalSettingsTarget.cs
@@ -5,10 +5,13 @@
     /// </summary>
     public enum ThermalSettingsTarget
     {
+        /// <summary>
+        ///     None
+        /// </summary>
         None = 0,
 
         /// <summary>
-        ///     GPU core temperature requires
+        ///     GPU core temperature
         /// </summary>
         GPU = 1,