Fix missing xml comments (#913)

Co-authored-by: Tomas Hellström <[email protected]>
net-daemon · Aug 20, 2023 · 9db4b38 · 9db4b38
1 parent 5ff1741
commit 9db4b38
Show file tree

Hide file tree

Showing 12 changed files with 47 additions and 35 deletions.
diff --git a/src/AppModel/NetDaemon.AppModel/Common/Attributes/JetBrainsCodeAnnotations.cs b/src/AppModel/NetDaemon.AppModel/Common/Attributes/JetBrainsCodeAnnotations.cs
@@ -25,6 +25,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 // ReSharper disable UnusedType.Global
 
 #pragma warning disable 1591
+#pragma warning disable CS1574, CS1584, CS1581, CS1580
 // ReSharper disable UnusedMember.Global
 // ReSharper disable MemberCanBePrivate.Global
 // ReSharper disable UnusedAutoPropertyAccessor.Global

diff --git a/...etDaemon.AppModel/Internal/AppAssemblyProviders/DynamicallyCompiledAppAssemblyProvider.cs b/...etDaemon.AppModel/Internal/AppAssemblyProviders/DynamicallyCompiledAppAssemblyProvider.cs
@@ -8,7 +8,7 @@ internal class DynamicallyCompiledAppAssemblyProvider : IAppAssemblyProvider, ID
     private readonly ICompiler _compiler;
 
     private Assembly? _compiledAssembly;
-    private CollectibleAssemblyLoadContext? _currentContext;
+    private CollectableAssemblyLoadContext? _currentContext;
 
     public DynamicallyCompiledAppAssemblyProvider(ICompiler compiler)
     {

diff --git a/src/AppModel/NetDaemon.AppModel/Internal/Compiler/CollectableAssemblyLoadContext.cs b/src/AppModel/NetDaemon.AppModel/Internal/Compiler/CollectableAssemblyLoadContext.cs
@@ -3,9 +3,9 @@
 
 namespace NetDaemon.AppModel.Internal.Compiler;
 
-public class CollectibleAssemblyLoadContext : AssemblyLoadContext
+internal class CollectableAssemblyLoadContext : AssemblyLoadContext
 {
-    public CollectibleAssemblyLoadContext() : base(true)
+    public CollectableAssemblyLoadContext() : base(true)
     {
     }
 

diff --git a/src/AppModel/NetDaemon.AppModel/Internal/Compiler/Compiler.cs b/src/AppModel/NetDaemon.AppModel/Internal/Compiler/Compiler.cs
@@ -3,7 +3,6 @@
 using System.Linq.Expressions;
 using System.Reflection;
 using System.Runtime;
-using System.Runtime.Loader;
 using System.Text.RegularExpressions;
 using Microsoft.CodeAnalysis;
 using Microsoft.CodeAnalysis.CSharp;
@@ -13,7 +12,7 @@
 
 namespace NetDaemon.AppModel.Internal.Compiler;
 
-internal record CompiledAssemblyResult(CollectibleAssemblyLoadContext AssemblyContext, Assembly CompiledAssembly);
+internal record CompiledAssemblyResult(CollectableAssemblyLoadContext AssemblyContext, Assembly CompiledAssembly);
 
 internal class Compiler : ICompiler
 {
@@ -33,7 +32,7 @@ public Compiler(
 
     public CompiledAssemblyResult Compile()
     {
-        CollectibleAssemblyLoadContext context = new();
+        CollectableAssemblyLoadContext context = new();
 
         var compilation = GetSharpCompilation();
 

diff --git a/src/AppModel/NetDaemon.AppModel/Internal/Config/Yaml/YamlConfigurationSource.cs b/src/AppModel/NetDaemon.AppModel/Internal/Config/Yaml/YamlConfigurationSource.cs
@@ -2,7 +2,7 @@
 
 namespace NetDaemon.AppModel.Internal.Config;
 
-public class YamlConfigurationSource : FileConfigurationSource
+internal class YamlConfigurationSource : FileConfigurationSource
 {
     public override IConfigurationProvider Build(IConfigurationBuilder builder)
     {

diff --git a/src/AppModel/NetDaemon.AppModel/NetDaemon.AppModel.csproj b/src/AppModel/NetDaemon.AppModel/NetDaemon.AppModel.csproj
@@ -7,28 +7,18 @@
         <Version>21.47.1</Version>
         <Authors>helto4real</Authors>
         <Company>JoySoftware</Company>
-        <description>A .net core client for Home Assistant</description>
-        <projectUrl>https://github.com/helto4real/net-hassclient</projectUrl>
+        <description>Application model for NetDaemon</description>
+        <projectUrl>https://github.com/net-daemon/netdaemon</projectUrl>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
         <PackageDescription>
-            A client for manage the free open source home automations software Home Assisstant written in .net core 3.
-            Please see https://github.com/helto4real/net-hassclient/blob/main/README.md for docs.
+            Provides NetDaemons application model
+            Please see https://github.com/net-daemon/netdaemon.
         </PackageDescription>
-        <PackageReleaseNotes>First alpha version, expect things to change!</PackageReleaseNotes>
         <tags>Home Assistant</tags>
         <RootNamespace>NetDaemon.AppModel</RootNamespace>
 		<GenerateDocumentationFile>True</GenerateDocumentationFile>
     </PropertyGroup>
 
-	<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
-		<NoWarn>1701;1702</NoWarn>
-		<!-- add these to also hide the warnings during development ;CS1591;CS1573 -->
-	</PropertyGroup>
-
-	<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
-		<NoWarn>1701;1702;CS1591;CS1574</NoWarn>
-	</PropertyGroup>
-
     <ItemGroup>
         <PackageReference Include="Microsoft.Extensions.Http" Version="7.0.0" />
         <PackageReference Include="Microsoft.Extensions.Hosting" Version="7.0.1" />

diff --git a/src/Client/NetDaemon.HassClient/NetDaemon.Client.csproj b/src/Client/NetDaemon.HassClient/NetDaemon.Client.csproj
@@ -8,25 +8,24 @@
         <Version>21.47.1</Version>
         <Authors>helto4real</Authors>
         <Company>JoySoftware</Company>
-        <description>A .net core client for Home Assistant</description>
-        <projectUrl>https://github.com/helto4real/net-hassclient</projectUrl>
+        <description>A .Net client for Home Assistant</description>
+        <projectUrl>https://github.com/net-daemon/netdaemon</projectUrl>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
         <PackageDescription>
-            A client for manage the free open source home automations software Home Assisstant written in .net core 3.
+            A client for manage the free open source home automations software Home Assisstant written in .Net.
             Please see https://github.com/helto4real/net-hassclient/blob/main/README.md for docs.
         </PackageDescription>
-        <PackageReleaseNotes>First alpha version, expect things to change!</PackageReleaseNotes>
+        <PackageReleaseNotes>This package is used internally by NetDaemon and not intended to be used directly. That means things could change if needed without prior notice</PackageReleaseNotes>
         <tags>Home Assistant</tags>
 		<GenerateDocumentationFile>True</GenerateDocumentationFile>
     </PropertyGroup>
 
 	<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
-		<NoWarn>1701;1702</NoWarn>
-		<!-- add these to also hide the warnings during development ;CS1591;CS1573 -->
+		<NoWarn>1701;1702;IL2121;CS1591</NoWarn>
 	</PropertyGroup>
 
 	<PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
-		<NoWarn>1701;1702;CS1591</NoWarn>
+		<NoWarn>1701;1702;IL2121;CS1591</NoWarn>
 	</PropertyGroup>
 
     <ItemGroup>

diff --git a/src/Runtime/NetDaemon.Runtime/Common/Extensions/HostBuilderExtensions.cs b/src/Runtime/NetDaemon.Runtime/Common/Extensions/HostBuilderExtensions.cs
@@ -5,10 +5,13 @@
 
 namespace NetDaemon.Runtime;
 
+/// <summary>
+/// NetDaemon.Runtime Extension methods for IHostBuilder
+/// </summary>
 public static class HostBuilderExtensions
 {
     /// <summary>
-    /// Call this method to load NetDeamonYaml settings, and to register 'ConfigureNetDaemonServices' in the service collection
+    /// Call this method to load NetDeamon Yaml settings, and to register 'ConfigureNetDaemonServices' in the service collection
     /// </summary>
     /// <param name="hostBuilder"></param>
     /// <remarks>
@@ -56,6 +59,9 @@ public static IHostBuilder RegisterYamlSettings(this IHostBuilder hostBuilder)
         });
     }
 
+    /// <summary>
+    /// Adds the NetDaemon Runtime Services to a HostBuilder
+    /// </summary>
     public static IHostBuilder UseNetDaemonRuntime(this IHostBuilder hostBuilder)
     {
         return hostBuilder

diff --git a/src/Runtime/NetDaemon.Runtime/Common/Extensions/ServiceBuilderExtensions.cs b/src/Runtime/NetDaemon.Runtime/Common/Extensions/ServiceBuilderExtensions.cs
@@ -3,8 +3,16 @@
 
 namespace NetDaemon.Runtime;
 
+/// <summary>
+/// NetDaemon.Runtime Extension methods for IServiceCollection
+/// </summary>
 public static class ServiceBuilderExtensions
 {
+    /// <summary>
+    /// COnfigures required sercvies to use the NetDaemon Application State manager
+    /// </summary>
+    /// <param name="services">The <see cref="IServiceCollection" /> to add services to.</param>
+    /// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
     public static IServiceCollection AddNetDaemonStateManager(this IServiceCollection services)
     {
         services.AddSingleton<AppStateManager>();

diff --git a/src/Runtime/NetDaemon.Runtime/Common/Extensions/ServiceCollectionExtensions.cs b/src/Runtime/NetDaemon.Runtime/Common/Extensions/ServiceCollectionExtensions.cs
@@ -2,8 +2,18 @@
 using NetDaemon.AppModel;
 
 namespace NetDaemon.Runtime;
+
+/// <summary>
+/// NetDaemon.Runtime Extension methods for IServiceCollection
+/// </summary>
 public static class ServiceCollectionExtensions
 {
+    /// <summary>
+    /// Loads NetDaemon and HomeAssistant configuration sections
+    /// </summary>
+    /// <param name="services">The <see cref="IServiceCollection" /> to add services to.</param>
+    /// <param name="config">The current <see cref="IConfiguration" /> instance</param>
+    /// <returns>The <see cref="IServiceCollection"/> so that additional calls can be chained.</returns>
     public static IServiceCollection ConfigureNetDaemonServices(this IServiceCollection services, IConfiguration config)
     {
         return services.Configure<AppConfigurationLocationSetting>(config.GetSection("NetDaemon"))

diff --git a/src/Runtime/NetDaemon.Runtime/Common/IRuntime.cs b/src/Runtime/NetDaemon.Runtime/Common/IRuntime.cs
@@ -1,6 +1,6 @@
 namespace NetDaemon.Runtime;
 
-public interface IRuntime : IAsyncDisposable
+internal interface IRuntime : IAsyncDisposable
 {
     Task StartAsync(CancellationToken stoppingToken);
 }
diff --git a/src/Runtime/NetDaemon.Runtime/NetDaemon.Runtime.csproj b/src/Runtime/NetDaemon.Runtime/NetDaemon.Runtime.csproj
@@ -7,14 +7,13 @@
         <Version>21.47.1</Version>
         <Authors>helto4real</Authors>
         <Company>JoySoftware</Company>
-        <description>A .net core client for Home Assistant</description>
-        <projectUrl>https://github.com/helto4real/net-hassclient</projectUrl>
+        <description>Runtime</description>
+        <projectUrl>https://github.com/net-daemon/netdaemon</projectUrl>
         <PackageLicenseExpression>MIT</PackageLicenseExpression>
         <PackageDescription>
-            A client for manage the free open source home automations software Home Assisstant written in .net core 3.
-            Please see https://github.com/helto4real/net-hassclient/blob/main/README.md for docs.
+            Runtime package for NetDeamon
+            Please see https://netdaemon.xyz for docs.
         </PackageDescription>
-        <PackageReleaseNotes>First alpha version, expect things to change!</PackageReleaseNotes>
         <tags>Home Assistant</tags>
         <RootNamespace>NetDaemon.Runtime</RootNamespace>
 		<GenerateDocumentationFile>True</GenerateDocumentationFile>