Skip to content

fix(common): preflight XML doc warnings for strict-gate composition #171

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

Closed
ottobolyos wants to merge 2 commits into from
Closed

fix(common): preflight XML doc warnings for strict-gate composition #171

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
e1bf51b
fix(common): escape '&' in XML doc comments under Streams/ and adapte…
ottobolyos May 26, 2026
4644f4f
fix(sysml): drop orphan 'logger' param tags on XmiDeserializer
ottobolyos May 26, 2026
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: 0 additions & 1 deletion libraries/MTConnect.NET-Common/Configurations/IAdapterApplicationConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@ public interface IAdapterApplicationConfiguration : IDataSourceConfiguration
bool EnableBuffer { get; set; }


/// <summary>
/// <summary>
/// Changes the service name when installing or removing the service. This allows multiple Adapters to run as services on the same machine.
/// </summary>
Expand Down
2 changes: 1 addition & 1 deletion libraries/MTConnect.NET-Common/Streams/DeviceStream.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public class DeviceStream : IDeviceStream
public IEnumerable<IComponentStream> ComponentStreams { get; set; }

/// <summary>
/// Gets All Observations (Samples, Events, & Conditions)
/// Gets All Observations (Samples, Events, &amp; Conditions)
/// </summary>
public IEnumerable<IObservation> Observations
{
Expand Down
2 changes: 1 addition & 1 deletion libraries/MTConnect.NET-Common/Streams/IComponentStream.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ public interface IComponentStream
string Uuid { get; }

/// <summary>
/// Gets All Observations (Samples, Events, & Conditions)
/// Gets All Observations (Samples, Events, &amp; Conditions)
/// </summary>
IEnumerable<IObservation> Observations { get; }

Expand Down
2 changes: 1 addition & 1 deletion libraries/MTConnect.NET-Common/Streams/IDeviceStream.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public interface IDeviceStream
IEnumerable<IComponentStream> ComponentStreams { get; }

/// <summary>
/// Gets All Observations (Samples, Events, & Conditions)
/// Gets All Observations (Samples, Events, &amp; Conditions)
/// </summary>
IEnumerable<IObservation> Observations { get; }

Expand Down
2 changes: 1 addition & 1 deletion libraries/MTConnect.NET-Common/Streams/IStreamsResponseDocument.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public interface IStreamsResponseDocument
Version Version { get; }

/// <summary>
/// Gets All Observations (Samples, Events, & Conditions)
/// Gets All Observations (Samples, Events, &amp; Conditions)
/// </summary>
IEnumerable<IObservation> GetObservations();
}
Expand Down
2 changes: 1 addition & 1 deletion libraries/MTConnect.NET-Common/Streams/Output/DeviceStreamOutput.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public class DeviceStreamOutput : IDeviceStreamOutput
public IComponentStreamOutput[] ComponentStreams { get; set; }

/// <summary>
/// Gets All Observations (Samples, Events, & Conditions)
/// Gets All Observations (Samples, Events, &amp; Conditions)
/// </summary>
public IEnumerable<IObservationOutput> Observations
{
Expand Down
2 changes: 1 addition & 1 deletion libraries/MTConnect.NET-Common/Streams/Output/IComponentStreamOutput.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public interface IComponentStreamOutput
string Uuid { get; }

/// <summary>
/// Gets All Observations (Samples, Events, & Conditions)
/// Gets All Observations (Samples, Events, &amp; Conditions)
/// </summary>
IObservationOutput[] Observations { get; }
}
Expand Down
2 changes: 1 addition & 1 deletion libraries/MTConnect.NET-Common/Streams/Output/IDeviceStreamOutput.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ public interface IDeviceStreamOutput
IComponentStreamOutput[] ComponentStreams { get; }

/// <summary>
/// Gets All Observations (Samples, Events, & Conditions)
/// Gets All Observations (Samples, Events, &amp; Conditions)
/// </summary>
IEnumerable<IObservationOutput> Observations { get; }
}
Expand Down
2 changes: 1 addition & 1 deletion libraries/MTConnect.NET-Common/Streams/Output/IStreamsResponseOutputDocument.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public interface IStreamsResponseOutputDocument
Version Version { get; }

/// <summary>
/// Gets All Observations (Samples, Events, & Conditions)
/// Gets All Observations (Samples, Events, &amp; Conditions)
/// </summary>
IEnumerable<IObservationOutput> GetObservations();

Expand Down
3 changes: 0 additions & 3 deletions libraries/MTConnect.NET-SysML/Xmi/XmiDeserializer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ public sealed class XmiDeserializer
/// Constructs a new instance of the deserializer with a reference to the source document.
/// </summary>
/// <param name="xmlDocument">A source of XMI to deserialize</param>
/// <param name="logger"><inheritdoc cref="ILogger" path="/summary"/></param>
public XmiDeserializer(XmlDocument xmlDocument)
{
xDoc = xmlDocument;
Expand Down Expand Up @@ -78,7 +77,6 @@ public XmiDeserializer(XmlDocument xmlDocument)
/// Creates a <see cref="XmiDeserializer"/> from a reference to the filepath of a XMI document.
/// </summary>
/// <param name="filename">Filepath to a XMI-formatted XML document.</param>
/// <param name="logger"><inheritdoc cref="ILogger" path="/summary"/></param>
/// <returns><inheritdoc cref="XmiDeserializer" path="/summary"/></returns>
public static XmiDeserializer FromFile(string filename)
{
Expand Down Expand Up @@ -106,7 +104,6 @@ public static XmiDeserializer FromFile(string filename)
/// Creates a <see cref="XmiDeserializer"/> from raw XML.
/// </summary>
/// <param name="xml">Raw XML string</param>
/// <param name="logger"><inheritdoc cref="ILogger" path="/summary"/></param>
/// <returns><inheritdoc cref="XmiDeserializer" path="/summary"/></returns>
public static XmiDeserializer FromXml(string xml)
{
Expand Down