From 8ec508e566dc2c32c91f8abaf0d9f5321539607d Mon Sep 17 00:00:00 2001 From: Frank Bakker Date: Thu, 17 Aug 2023 22:50:06 +0200 Subject: [PATCH] Fix missing xml comments --- .../Attributes/JetBrainsCodeAnnotations.cs | 1 + .../DynamicallyCompiledAppAssemblyProvider.cs | 2 +- .../Compiler/CollectableAssemblyLoadContext.cs | 4 ++-- .../Internal/Compiler/Compiler.cs | 5 ++--- .../Config/Yaml/YamlConfigurationSource.cs | 2 +- .../NetDaemon.AppModel.csproj | 18 ++++-------------- .../NetDaemon.Client.csproj | 13 ++++++------- .../Common/Extensions/HostBuilderExtensions.cs | 8 +++++++- .../Extensions/ServiceBuilderExtensions.cs | 8 ++++++++ .../Extensions/ServiceCollectionExtensions.cs | 10 ++++++++++ .../NetDaemon.Runtime/Common/IRuntime.cs | 2 +- .../NetDaemon.Runtime/NetDaemon.Runtime.csproj | 9 ++++----- 12 files changed, 47 insertions(+), 35 deletions(-) diff --git a/src/AppModel/NetDaemon.AppModel/Common/Attributes/JetBrainsCodeAnnotations.cs b/src/AppModel/NetDaemon.AppModel/Common/Attributes/JetBrainsCodeAnnotations.cs index efbd7d708..009a019d2 100644 --- 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/src/AppModel/NetDaemon.AppModel/Internal/AppAssemblyProviders/DynamicallyCompiledAppAssemblyProvider.cs b/src/AppModel/NetDaemon.AppModel/Internal/AppAssemblyProviders/DynamicallyCompiledAppAssemblyProvider.cs index ab631abc6..a575dacd7 100644 --- a/src/AppModel/NetDaemon.AppModel/Internal/AppAssemblyProviders/DynamicallyCompiledAppAssemblyProvider.cs +++ b/src/AppModel/NetDaemon.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 index 5a424ce49..edb9a414f 100644 --- 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 index 2c33c8e2c..d8b539275 100644 --- 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 index ea86c6001..c7f345b38 100644 --- 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 index 6be306347..06db976dc 100644 --- a/src/AppModel/NetDaemon.AppModel/NetDaemon.AppModel.csproj +++ b/src/AppModel/NetDaemon.AppModel/NetDaemon.AppModel.csproj @@ -7,28 +7,18 @@ 21.47.1 helto4real JoySoftware - A .net core client for Home Assistant - https://github.com/helto4real/net-hassclient + Application model for NetDaemon + https://github.com/net-daemon/netdaemon MIT - 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. - First alpha version, expect things to change! Home Assistant NetDaemon.AppModel True - - 1701;1702 - - - - - 1701;1702;CS1591;CS1574 - - diff --git a/src/Client/NetDaemon.HassClient/NetDaemon.Client.csproj b/src/Client/NetDaemon.HassClient/NetDaemon.Client.csproj index fd71d33f2..72a6de89e 100644 --- a/src/Client/NetDaemon.HassClient/NetDaemon.Client.csproj +++ b/src/Client/NetDaemon.HassClient/NetDaemon.Client.csproj @@ -8,25 +8,24 @@ 21.47.1 helto4real JoySoftware - A .net core client for Home Assistant - https://github.com/helto4real/net-hassclient + A .Net client for Home Assistant + https://github.com/net-daemon/netdaemon MIT - 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. - First alpha version, expect things to change! + This package is used internally by NetDaemon and not intended to be used directly. That means things could change if needed without prior notice Home Assistant True - 1701;1702 - + 1701;1702;IL2121;CS1591 - 1701;1702;CS1591 + 1701;1702;IL2121;CS1591 diff --git a/src/Runtime/NetDaemon.Runtime/Common/Extensions/HostBuilderExtensions.cs b/src/Runtime/NetDaemon.Runtime/Common/Extensions/HostBuilderExtensions.cs index 662a0300d..ba3024c30 100644 --- 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; +/// +/// NetDaemon.Runtime Extension methods for IHostBuilder +/// public static class HostBuilderExtensions { /// - /// 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 /// /// /// @@ -56,6 +59,9 @@ public static IHostBuilder RegisterYamlSettings(this IHostBuilder hostBuilder) }); } + /// + /// Adds the NetDaemon Runtime Services to a HostBuilder + /// 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 index 4f066cfd2..da409fff1 100644 --- 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; +/// +/// NetDaemon.Runtime Extension methods for IServiceCollection +/// public static class ServiceBuilderExtensions { + /// + /// COnfigures required sercvies to use the NetDaemon Application State manager + /// + /// The to add services to. + /// The so that additional calls can be chained. public static IServiceCollection AddNetDaemonStateManager(this IServiceCollection services) { services.AddSingleton(); diff --git a/src/Runtime/NetDaemon.Runtime/Common/Extensions/ServiceCollectionExtensions.cs b/src/Runtime/NetDaemon.Runtime/Common/Extensions/ServiceCollectionExtensions.cs index fc4bdb6d1..784671829 100644 --- 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; + +/// +/// NetDaemon.Runtime Extension methods for IServiceCollection +/// public static class ServiceCollectionExtensions { + /// + /// Loads NetDaemon and HomeAssistant configuration sections + /// + /// The to add services to. + /// The current instance + /// The so that additional calls can be chained. public static IServiceCollection ConfigureNetDaemonServices(this IServiceCollection services, IConfiguration config) { return services.Configure(config.GetSection("NetDaemon")) diff --git a/src/Runtime/NetDaemon.Runtime/Common/IRuntime.cs b/src/Runtime/NetDaemon.Runtime/Common/IRuntime.cs index 023eb35c9..9e050cea3 100644 --- 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); } \ No newline at end of file diff --git a/src/Runtime/NetDaemon.Runtime/NetDaemon.Runtime.csproj b/src/Runtime/NetDaemon.Runtime/NetDaemon.Runtime.csproj index 57bbb018b..9ea8cd1a0 100644 --- a/src/Runtime/NetDaemon.Runtime/NetDaemon.Runtime.csproj +++ b/src/Runtime/NetDaemon.Runtime/NetDaemon.Runtime.csproj @@ -7,14 +7,13 @@ 21.47.1 helto4real JoySoftware - A .net core client for Home Assistant - https://github.com/helto4real/net-hassclient + Runtime + https://github.com/net-daemon/netdaemon MIT - 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. - First alpha version, expect things to change! Home Assistant NetDaemon.Runtime True