Skip to content
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.

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

Autoformatting cleanup #278

Merged
merged 1 commit into from
Feb 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion Source/Meadow.Contracts/Cloud/IHealthReporter.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public interface IHealthReporter
/// <param name="func">Function to calculate metric value.</param>
/// <returns></returns>
bool AddMetric(string name, Func<object> func);

/// <summary>
/// Add a custom health metric.
/// </summary>
Expand Down
4 changes: 2 additions & 2 deletions Source/Meadow.Contracts/Cloud/IMeadowCloudService.cs
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ public interface IMeadowCloudService
/// <summary>
/// Gets the current number of items to be sent.
/// </summary>
int QueueCount { get ; }
int QueueCount { get; }

/// <summary>
/// Sends a log message to the Meadow.Cloud service
/// </summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,11 @@

namespace Meadow.Hardware
{
/// <summary>
/// Contract for ports that are capable of reading digital inputs and raising
/// events when state changes.
/// </summary>
public interface IDigitalInterruptPort : IDigitalInputPort, IObservable<IChangeResult<DigitalState>>
/// <summary>
/// Contract for ports that are capable of reading digital inputs and raising
/// events when state changes.
/// </summary>
public interface IDigitalInterruptPort : IDigitalInputPort, IObservable<IChangeResult<DigitalState>>
{
//TODO: should this be `Updated`?
/// <summary>
Expand Down
38 changes: 19 additions & 19 deletions Source/Meadow.Contracts/Hardware/SerialPortNameExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -53,23 +53,23 @@ public static ISerialMessagePort CreateSerialMessagePort(
int readBufferSize = 512)
{
return name.SerialMessageController?.CreateSerialMessagePort(name, suffixDelimiter, preserveDelimiter, baudRate, dataBits, parity, stopBits, readBufferSize)
?? throw new Exception($"Port {name} does not have a valid serial controller");
}
?? throw new Exception($"Port {name} does not have a valid serial controller");
}

/// <summary>
/// Creates an <see cref="ISerialMessagePort"/> directly from a <see cref="SerialPortName"/> using the current <see cref="IMeadowDevice"/>
/// </summary>
/// <param name="name"></param>
/// <param name="prefixDelimiter"></param>
/// <param name="preserveDelimiter"></param>
/// <param name="messageLength"></param>
/// <param name="baudRate"></param>
/// <param name="dataBits"></param>
/// <param name="parity"></param>
/// <param name="stopBits"></param>
/// <param name="readBufferSize"></param>
/// <returns></returns>
public static ISerialMessagePort CreateSerialMessagePort(
/// <summary>
/// Creates an <see cref="ISerialMessagePort"/> directly from a <see cref="SerialPortName"/> using the current <see cref="IMeadowDevice"/>
/// </summary>
/// <param name="name"></param>
/// <param name="prefixDelimiter"></param>
/// <param name="preserveDelimiter"></param>
/// <param name="messageLength"></param>
/// <param name="baudRate"></param>
/// <param name="dataBits"></param>
/// <param name="parity"></param>
/// <param name="stopBits"></param>
/// <param name="readBufferSize"></param>
/// <returns></returns>
public static ISerialMessagePort CreateSerialMessagePort(
this SerialPortName name,
byte[] prefixDelimiter,
bool preserveDelimiter,
Expand All @@ -81,7 +81,7 @@ public static ISerialMessagePort CreateSerialMessagePort(
int readBufferSize = 512)
{
return name.SerialMessageController?.CreateSerialMessagePort(name, prefixDelimiter, preserveDelimiter, messageLength, baudRate, dataBits, parity, stopBits, readBufferSize)
?? throw new Exception($"Port {name} does not have a valid serial controller");
}
}
?? throw new Exception($"Port {name} does not have a valid serial controller");
}
}
}
4 changes: 2 additions & 2 deletions Source/Meadow.Contracts/Update/UpdateMessage.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ public string MpakID
/// Gets or sets the download URL of the MPak.
/// </summary>
public string MpakDownloadUrl { get; set; } = default!;

/// <summary>
/// Gets or sets the download URL of the MPak including OS.
/// </summary>
public string MpakWithOsDownloadUrl { get; set; } = default!;

/// <summary>
/// Target OS Version for the update.
/// </summary>
Expand Down