Skip to content

Fix missing xml comments #913

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 20, 2023
Merged

Fix missing xml comments #913

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8ec508e
Fix missing xml comments
FrankBakkerNl Aug 17, 2023
4067287
Merge branch 'dev' into add_xml_comments
helto4real Aug 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions src/AppModel/NetDaemon.AppModel/Common/Attributes/JetBrainsCodeAnnotations.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion ...etDaemon.AppModel/Internal/AppAssemblyProviders/DynamicallyCompiledAppAssemblyProvider.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
Expand Down
4 changes: 2 additions & 2 deletions src/AppModel/NetDaemon.AppModel/Internal/Compiler/CollectableAssemblyLoadContext.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
{
}

Expand Down
5 changes: 2 additions & 3 deletions src/AppModel/NetDaemon.AppModel/Internal/Compiler/Compiler.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand All @@ -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
{
Expand All @@ -33,7 +32,7 @@ public Compiler(

public CompiledAssemblyResult Compile()
{
CollectibleAssemblyLoadContext context = new();
CollectableAssemblyLoadContext context = new();

var compilation = GetSharpCompilation();

Expand Down
2 changes: 1 addition & 1 deletion src/AppModel/NetDaemon.AppModel/Internal/Config/Yaml/YamlConfigurationSource.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

namespace NetDaemon.AppModel.Internal.Config;

public class YamlConfigurationSource : FileConfigurationSource
internal class YamlConfigurationSource : FileConfigurationSource
{
public override IConfigurationProvider Build(IConfigurationBuilder builder)
{
Expand Down
18 changes: 4 additions & 14 deletions src/AppModel/NetDaemon.AppModel/NetDaemon.AppModel.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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" />
Expand Down
13 changes: 6 additions & 7 deletions src/Client/NetDaemon.HassClient/NetDaemon.Client.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
8 changes: 7 additions & 1 deletion src/Runtime/NetDaemon.Runtime/Common/Extensions/HostBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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
Expand Down
8 changes: 8 additions & 0 deletions src/Runtime/NetDaemon.Runtime/Common/Extensions/ServiceBuilderExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>();
Expand Down
10 changes: 10 additions & 0 deletions src/Runtime/NetDaemon.Runtime/Common/Extensions/ServiceCollectionExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"))
Expand Down
2 changes: 1 addition & 1 deletion src/Runtime/NetDaemon.Runtime/Common/IRuntime.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
namespace NetDaemon.Runtime;

public interface IRuntime : IAsyncDisposable
internal interface IRuntime : IAsyncDisposable
{
Task StartAsync(CancellationToken stoppingToken);
}
9 changes: 4 additions & 5 deletions src/Runtime/NetDaemon.Runtime/NetDaemon.Runtime.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Copy link
Collaborator

@helto4real helto4real Aug 20, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hehe this must been slipping through from old code :). Good find :)

<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>
Expand Down