Adkust based on SonarCloud

Ellerbach · Ellerbach · commit 4a625310afa2 · 2021-05-21T14:19:00.000+02:00
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nanoFramework.System.IO.Ports&metric=alert_status)](https://sonarcloud.io/dashboard?id=nanoFramework.System.IO.Ports) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=nanoFramework.System.IO.Ports&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=nanoFramework.System.IO.Ports) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![NuGet](https://img.shields.io/nuget/dt/nanoFramework.System.IO.Ports.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.System.IO.Ports/) [![#yourfirstpr](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://github.com/nanoframework/Home/blob/master/CONTRIBUTING.md)[![Discord](https://img.shields.io/discord/478725473862549535.svg?logo=discord&logoColor=white&label=Discord&color=7289DA)](https://discord.gg/gCyBu8T)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nanoframework_System.IO.Ports&metric=alert_status)](https://sonarcloud.io/dashboard?id=nanoframework_System.IO.Ports) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=nanoframework_System.IO.Ports&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=nanoframework_System.IO.Ports) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![NuGet](https://img.shields.io/nuget/dt/nanoFramework.System.IO.Ports.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.System.IO.Ports/) [![#yourfirstpr](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://github.com/nanoframework/Home/blob/master/CONTRIBUTING.md) [![Discord](https://img.shields.io/discord/478725473862549535.svg?logo=discord&logoColor=white&label=Discord&color=7289DA)](https://discord.gg/gCyBu8T)
 
 ![nanoFramework logo](https://github.com/nanoframework/Home/blob/master/resources/logo/nanoFramework-repo-logo.png)
 
diff --git a/System.IO.Ports/Parity.cs b/System.IO.Ports/Parity.cs
@@ -1,4 +1,9 @@
-﻿namespace System.IO.Ports
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
+namespace System.IO.Ports
 {
     /// <summary>
     /// Specifies the parity bit for a System.IO.Ports.SerialPort object.
diff --git a/System.IO.Ports/SerialData.cs b/System.IO.Ports/SerialData.cs
@@ -1,4 +1,8 @@
-﻿
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
 namespace System.IO.Ports
 {
     /// <summary>
diff --git a/System.IO.Ports/SerialDataReceivedEventArgs.cs b/System.IO.Ports/SerialDataReceivedEventArgs.cs
@@ -1,11 +1,16 @@
-﻿namespace System.IO.Ports
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
+namespace System.IO.Ports
 { 
     /// <summary>
     /// Provides data for the System.IO.Ports.SerialPort.DataReceived event.
     /// </summary>
     public class SerialDataReceivedEventArgs : EventArgs
     {
-        SerialData _data;
+        private readonly SerialData _data;
 
         internal SerialDataReceivedEventArgs(SerialData eventCode)
         {
diff --git a/System.IO.Ports/SerialDataReceivedEventHandler.cs b/System.IO.Ports/SerialDataReceivedEventHandler.cs
@@ -1,4 +1,9 @@
-﻿namespace System.IO.Ports
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
+namespace System.IO.Ports
 {
     /// <summary>
     /// Represents the method that will handle the System.IO.Ports.SerialPort.DataReceived
diff --git a/System.IO.Ports/SerialDeviceEventListener.cs b/System.IO.Ports/SerialDeviceEventListener.cs
@@ -12,7 +12,7 @@ namespace System.IO.Ports
     internal class SerialDeviceEventListener : IEventProcessor, IEventListener
     {
         // Map of serial device numbers to SerialDevice objects.
-        private ArrayList _serialDevicesMap = new ArrayList();
+        private readonly ArrayList _serialDevicesMap = new ArrayList();
 
         public SerialDeviceEventListener()
         {
diff --git a/System.IO.Ports/SerialMode.cs b/System.IO.Ports/SerialMode.cs
@@ -1,4 +1,8 @@
-﻿
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
 namespace System.IO.Ports
 {
 	/// <summary>
diff --git a/System.IO.Ports/SerialPort.cs b/System.IO.Ports/SerialPort.cs
@@ -1,4 +1,8 @@
-﻿
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
 using System.Runtime.CompilerServices;
 using System.Text;
 using System.Collections;
@@ -38,7 +42,7 @@ public class SerialPort : IDisposable
         private char _watchChar;
         private SerialDataReceivedEventHandler _callbacksDataReceivedEvent = null;
         private SerialStream _stream;
-        private object _syncLock;
+        private readonly object _syncLock;
         private string _newLine;
         private bool _hasBeenOpened = false;
 
@@ -270,7 +274,7 @@ public StopBits StopBits
         /// Gets or sets the port for communications, including but not limited to all available
         /// COM ports.
         /// </summary>
-        /// <exception cref=ArgumentException"">The System.IO.Ports.SerialPort.PortName property was set to a value with a length
+        /// <exception cref="ArgumentException">The System.IO.Ports.SerialPort.PortName property was set to a value with a length
         /// of zero. -or- The System.IO.Ports.SerialPort.PortName property was set to a value
         /// that starts with "\\". -or- The port name was not valid.</exception>
         /// <exception cref="ArgumentNullException">The System.IO.Ports.SerialPort.PortName property was set to null.</exception>
@@ -611,8 +615,8 @@ public string ReadExisting()
             }
 
             byte[] toRead = new byte[BytesToRead];
-            var ret = NativeRead(toRead, 0, toRead.Length);
-            // normally ret == toRead.Length
+            NativeRead(toRead, 0, toRead.Length);
+            // An exception is thrown if timeout, so we are sure to read only 1 byte properly
             return Encoding.GetString(toRead, 0, toRead.Length);
         }
 
@@ -837,6 +841,9 @@ protected void Dispose(bool disposing)
             }
         }
 
+        /// <summary>
+        /// Dispose the Serial Port
+        /// </summary>
         public void Dispose()
         {
             lock (_syncLock)
diff --git a/System.IO.Ports/SerialStream.cs b/System.IO.Ports/SerialStream.cs
@@ -1,11 +1,16 @@
-﻿using System;
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
+using System;
 using System.Text;
 
 namespace System.IO.Ports
 {
     internal class SerialStream : Stream
     {
-        private SerialPort _serial;
+        private readonly SerialPort _serial;
 
         internal SerialStream(SerialPort serial)
         {
diff --git a/System.IO.Ports/StopBits.cs b/System.IO.Ports/StopBits.cs
@@ -1,4 +1,9 @@
-﻿namespace System.IO.Ports
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
+namespace System.IO.Ports
 {
     /// <summary>
     /// Specifies the number of stop bits used on the System.IO.Ports.SerialPort object.
diff --git a/Tests/UnitTestsSerialPort/SerialTests.cs b/Tests/UnitTestsSerialPort/SerialTests.cs
@@ -1,4 +1,9 @@
-﻿using nanoFramework.Hardware.Esp32;
+﻿//
+// Copyright (c) .NET Foundation and Contributors
+// See LICENSE file in the project root for full license information.
+//
+
+using nanoFramework.Hardware.Esp32;
 using nanoFramework.TestFramework;
 using System;
 using System.Diagnostics;

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nanoFramework.System.IO.Ports&metric=alert_status)](https://sonarcloud.io/dashboard?id=nanoFramework.System.IO.Ports) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=nanoFramework.System.IO.Ports&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=nanoFramework.System.IO.Ports) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![NuGet](https://img.shields.io/nuget/dt/nanoFramework.System.IO.Ports.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.System.IO.Ports/) [![#yourfirstpr](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://github.com/nanoframework/Home/blob/master/CONTRIBUTING.md)[![Discord](https://img.shields.io/discord/478725473862549535.svg?logo=discord&logoColor=white&label=Discord&color=7289DA)](https://discord.gg/gCyBu8T)
	`1`	+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nanoframework_System.IO.Ports&metric=alert_status)](https://sonarcloud.io/dashboard?id=nanoframework_System.IO.Ports) [![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=nanoframework_System.IO.Ports&metric=reliability_rating)](https://sonarcloud.io/dashboard?id=nanoframework_System.IO.Ports) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![NuGet](https://img.shields.io/nuget/dt/nanoFramework.System.IO.Ports.svg?label=NuGet&style=flat&logo=nuget)](https://www.nuget.org/packages/nanoFramework.System.IO.Ports/) [![#yourfirstpr](https://img.shields.io/badge/first--timers--only-friendly-blue.svg)](https://github.com/nanoframework/Home/blob/master/CONTRIBUTING.md) [![Discord](https://img.shields.io/discord/478725473862549535.svg?logo=discord&logoColor=white&label=Discord&color=7289DA)](https://discord.gg/gCyBu8T)
`2`	`2`
`3`	`3`	`![nanoFramework logo](https://github.com/nanoframework/Home/blob/master/resources/logo/nanoFramework-repo-logo.png)`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,16 @@`
`1`		`-namespace System.IO.Ports`
	`1`	`+//`
	`2`	`+// Copyright (c) .NET Foundation and Contributors`
	`3`	`+// See LICENSE file in the project root for full license information.`
	`4`	`+//`
	`5`	`+`
	`6`	`+namespace System.IO.Ports`
`2`	`7`	`{`
`3`	`8`	`/// <summary>`
`4`	`9`	`/// Provides data for the System.IO.Ports.SerialPort.DataReceived event.`
`5`	`10`	`/// </summary>`
`6`	`11`	`public class SerialDataReceivedEventArgs : EventArgs`
`7`	`12`	`{`
`8`		`- SerialData _data;`
	`13`	`+ private readonly SerialData _data;`
`9`	`14`
`10`	`15`	`internal SerialDataReceivedEventArgs(SerialData eventCode)`
`11`	`16`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ namespace System.IO.Ports`
`12`	`12`	`internal class SerialDeviceEventListener : IEventProcessor, IEventListener`
`13`	`13`	`{`
`14`	`14`	`// Map of serial device numbers to SerialDevice objects.`
`15`		`- private ArrayList _serialDevicesMap = new ArrayList();`
	`15`	`+ private readonly ArrayList _serialDevicesMap = new ArrayList();`
`16`	`16`
`17`	`17`	`public SerialDeviceEventListener()`
`18`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -1,11 +1,16 @@`
`1`		`-using System;`
	`1`	`+//`
	`2`	`+// Copyright (c) .NET Foundation and Contributors`
	`3`	`+// See LICENSE file in the project root for full license information.`
	`4`	`+//`
	`5`	`+`
	`6`	`+using System;`
`2`	`7`	`using System.Text;`
`3`	`8`
`4`	`9`	`namespace System.IO.Ports`
`5`	`10`	`{`
`6`	`11`	`internal class SerialStream : Stream`
`7`	`12`	`{`
`8`		`- private SerialPort _serial;`
	`13`	`+ private readonly SerialPort _serial;`
`9`	`14`
`10`	`15`	`internal SerialStream(SerialPort serial)`
`11`	`16`	`{`