Skip to content

Commit b896135

Browse files
torbaczrkalwakEllerbach
authored
Apply StyleCop to several projects (#601)
Co-authored-by: Rafał Kałwak <[email protected]> Co-authored-by: Laurent Ellerbach <[email protected]>
1 parent 1de7e0c commit b896135

File tree

99 files changed

+2024
-785
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+2024
-785
lines changed

‎devices/Bh1750fvi/Bh1750fvi.cs

+15-15
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@
1010
namespace Iot.Device.Bh1750fvi
1111
{
1212
/// <summary>
13-
/// Ambient Light Sensor BH1750FVI
13+
/// Ambient Light Sensor BH1750FVI.
1414
/// </summary>
1515
[Interface("Ambient Light Sensor BH1750FVI")]
1616
public class Bh1750fvi : IDisposable
1717
{
18-
private const byte DefaultLightTransmittance = 0b_0100_0101;
18+
private const byte DefaultLightTransmittance = 0b0100_0101;
1919

2020
private I2cDevice _i2cDevice;
2121

2222
private double _lightTransmittance;
2323

2424
/// <summary>
25-
/// BH1750FVI Light Transmittance, from 27.20% to 222.50%
25+
/// Gets or sets light transmittance, from 27.20% to 222.50%.
2626
/// </summary>
2727
[Property]
2828
public double LightTransmittance
@@ -36,23 +36,23 @@ public double LightTransmittance
3636
}
3737

3838
/// <summary>
39-
/// BH1750FVI Measuring Mode
39+
/// Gets or sets measuring mode.
4040
/// </summary>
4141
[Property]
4242
public MeasuringMode MeasuringMode { get; set; }
4343

4444
/// <summary>
45-
/// BH1750FVI Illuminance (Lux)
45+
/// BH1750FVI Illuminance (Lux).
4646
/// </summary>
4747
[Telemetry]
4848
public Illuminance Illuminance => GetIlluminance();
4949

5050
/// <summary>
51-
/// Creates a new instance of the BH1750FVI
51+
/// Initializes a new instance of the <see cref="Bh1750fvi" /> class.
5252
/// </summary>
5353
/// <param name="i2cDevice">The I2C device used for communication.</param>
54-
/// <param name="measuringMode">The measuring mode of BH1750FVI</param>
55-
/// <param name="lightTransmittance">BH1750FVI Light Transmittance, from 27.20% to 222.50%</param>
54+
/// <param name="measuringMode">The measuring mode of BH1750FVI.</param>
55+
/// <param name="lightTransmittance">BH1750FVI Light Transmittance, from 27.20% to 222.50%.</param>
5656
public Bh1750fvi(I2cDevice i2cDevice, MeasuringMode measuringMode = MeasuringMode.ContinuouslyHighResolutionMode, double lightTransmittance = 1)
5757
{
5858
_i2cDevice = i2cDevice ?? throw new ArgumentNullException(nameof(i2cDevice));
@@ -65,9 +65,9 @@ public Bh1750fvi(I2cDevice i2cDevice, MeasuringMode measuringMode = MeasuringMod
6565
}
6666

6767
/// <summary>
68-
/// Set BH1750FVI Light Transmittance
68+
/// Set BH1750FVI Light Transmittance.
6969
/// </summary>
70-
/// <param name="transmittance">Light Transmittance, from 27.20% to 222.50%</param>
70+
/// <param name="transmittance">Light Transmittance, from 27.20% to 222.50%.</param>
7171
private void SetLightTransmittance(double transmittance)
7272
{
7373
if (transmittance > 2.225 || transmittance < 0.272)
@@ -78,13 +78,13 @@ private void SetLightTransmittance(double transmittance)
7878
byte val = (byte)(DefaultLightTransmittance / transmittance);
7979

8080
_i2cDevice.WriteByte((byte)((byte)Command.MeasurementTimeHigh | (val >> 5)));
81-
_i2cDevice.WriteByte((byte)((byte)Command.MeasurementTimeLow | (val & 0b_0001_1111)));
81+
_i2cDevice.WriteByte((byte)((byte)Command.MeasurementTimeLow | (val & 0b0001_1111)));
8282
}
8383

8484
/// <summary>
85-
/// Get BH1750FVI Illuminance
85+
/// Get BH1750FVI Illuminance.
8686
/// </summary>
87-
/// <returns>Illuminance (Default unit: Lux)</returns>
87+
/// <returns>Illuminance (Default unit: Lux).</returns>
8888
private Illuminance GetIlluminance()
8989
{
9090
if (MeasuringMode == MeasuringMode.OneTimeHighResolutionMode || MeasuringMode == MeasuringMode.OneTimeHighResolutionMode2 || MeasuringMode == MeasuringMode.OneTimeLowResolutionMode)
@@ -110,12 +110,12 @@ private Illuminance GetIlluminance()
110110
}
111111

112112
/// <summary>
113-
/// Cleanup
113+
/// <inheritdoc/>
114114
/// </summary>
115115
public void Dispose()
116116
{
117117
_i2cDevice?.Dispose();
118-
_i2cDevice = null!;
118+
_i2cDevice = null;
119119
}
120120
}
121121
}

‎devices/Bh1750fvi/Bh1750fvi.nfproj

+9-1
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
<TargetFrameworkVersion>v1.0</TargetFrameworkVersion>
1919
<DocumentationFile>bin\$(Configuration)\Iot.Device.Bh1750fvi.xml</DocumentationFile>
2020
<LangVersion>9.0</LangVersion>
21+
<StyleCopTreatErrorsAsWarnings>false</StyleCopTreatErrorsAsWarnings>
2122
</PropertyGroup>
2223
<PropertyGroup>
2324
<SignAssembly>true</SignAssembly>
@@ -76,4 +77,11 @@
7677
<Error Condition="!Exists('packages\Nerdbank.GitVersioning.3.5.113\build\Nerdbank.GitVersioning.targets')" Text="$([System.String]::Format('$(ErrorText)', 'packages\Nerdbank.GitVersioning.3.5.113\build\Nerdbank.GitVersioning.targets'))" />
7778
</Target>
7879
<Import Project="packages\Nerdbank.GitVersioning.3.5.113\build\Nerdbank.GitVersioning.targets" Condition="Exists('packages\Nerdbank.GitVersioning.3.5.113\build\Nerdbank.GitVersioning.targets')" />
79-
</Project>
80+
<Import Project="packages\StyleCop.MSBuild.6.2.0\build\StyleCop.MSBuild.targets" Condition="Exists('packages\StyleCop.MSBuild.6.2.0\build\StyleCop.MSBuild.targets')" />
81+
<Target Name="EnsureNuGetPackageBuildImports" BeforeTargets="PrepareForBuild">
82+
<PropertyGroup>
83+
<ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them. For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
84+
</PropertyGroup>
85+
<Error Condition="!Exists('packages\StyleCop.MSBuild.6.2.0\build\StyleCop.MSBuild.targets')" Text="$([System.String]::Format('$(ErrorText)', 'packages\StyleCop.MSBuild.6.2.0\build\StyleCop.MSBuild.targets'))" />
86+
</Target>
87+
</Project>

‎devices/Bh1750fvi/Command.cs

+5-5
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@ namespace Iot.Device.Bh1750fvi
55
{
66
internal enum Command : byte
77
{
8-
PowerDown = 0b_0000_0000,
9-
PowerOn = 0b_0000_0001,
10-
Reset = 0b_0000_0111,
11-
MeasurementTimeHigh = 0b_0100_0000,
12-
MeasurementTimeLow = 0b_0110_0000,
8+
PowerDown = 0b0000_0000,
9+
PowerOn = 0b0000_0001,
10+
Reset = 0b0000_0111,
11+
MeasurementTimeHigh = 0b0100_0000,
12+
MeasurementTimeLow = 0b0110_0000,
1313
}
1414
}

‎devices/Bh1750fvi/I2cAddress.cs

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,17 @@
44
namespace Iot.Device.Bh1750fvi
55
{
66
/// <summary>
7-
/// BH1750FVI I2C Address
7+
/// BH1750FVI I2C Address.
88
/// </summary>
99
public enum I2cAddress : byte
1010
{
1111
/// <summary>
12-
/// ADD Pin connect to high power level
12+
/// ADD Pin connect to high power level.
1313
/// </summary>
1414
AddPinHigh = 0x5C,
1515

1616
/// <summary>
17-
/// ADD Pin connect to low power level
17+
/// ADD Pin connect to low power level.
1818
/// </summary>
1919
AddPinLow = 0x23
2020
}

‎devices/Bh1750fvi/MeasuringMode.cs

+7-7
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
namespace Iot.Device.Bh1750fvi
55
{
66
/// <summary>
7-
/// The measuring mode of BH1750FVI
7+
/// The measuring mode of BH1750FVI.
88
/// </summary>
99
public enum MeasuringMode : byte
1010
{
@@ -14,39 +14,39 @@ public enum MeasuringMode : byte
1414
/// Start measurement at 1lx resolution
1515
/// Measurement Time is typically 120ms.
1616
/// </summary>
17-
ContinuouslyHighResolutionMode = 0b_0001_0000,
17+
ContinuouslyHighResolutionMode = 0b0001_0000,
1818

1919
/// <summary>
2020
/// Start measurement at 0.5lx resolution
2121
/// Measurement Time is typically 120ms.
2222
/// </summary>
23-
ContinuouslyHighResolutionMode2 = 0b_0001_0001,
23+
ContinuouslyHighResolutionMode2 = 0b0001_0001,
2424

2525
/// <summary>
2626
/// Start measurement at 4lx resolution
2727
/// Measurement Time is typically 16ms.
2828
/// </summary>
29-
ContinuouslyLowResolutionMode = 0b_0001_0011,
29+
ContinuouslyLowResolutionMode = 0b0001_0011,
3030

3131
/// <summary>
3232
/// Start measurement at 1lx resolution once
3333
/// Measurement Time is typically 120ms.
3434
/// It is automatically set to Power Down mode after measurement.
3535
/// </summary>
36-
OneTimeHighResolutionMode = 0b_0010_0000,
36+
OneTimeHighResolutionMode = 0b0010_0000,
3737

3838
/// <summary>
3939
/// Start measurement at 0.5lx resolution once
4040
/// Measurement Time is typically 120ms.
4141
/// It is automatically set to Power Down mode after measurement.
4242
/// </summary>
43-
OneTimeHighResolutionMode2 = 0b_0010_0001,
43+
OneTimeHighResolutionMode2 = 0b0010_0001,
4444

4545
/// <summary>
4646
/// Start measurement at 4lx resolution once
4747
/// Measurement Time is typically 16ms.
4848
/// It is automatically set to Power Down mode after measurement.
4949
/// </summary>
50-
OneTimeLowResolutionMode = 0b_0010_0011
50+
OneTimeLowResolutionMode = 0b0010_0011
5151
}
5252
}

‎devices/Bh1750fvi/Properties/AssemblyInfo.cs

+4-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
// Licensed to the .NET Foundation under one or more agreements.
2+
// The .NET Foundation licenses this file to you under the MIT license.
3+
14
using System.Reflection;
25
using System.Runtime.CompilerServices;
36
using System.Runtime.InteropServices;
@@ -6,5 +9,4 @@
69
[assembly: AssemblyCompany("nanoFramework Contributors")]
710
[assembly: AssemblyCopyright("Copyright(c).NET Foundation and Contributors")]
811

9-
[assembly: ComVisible(false)]
10-
12+
[assembly: ComVisible(false)]

‎devices/Bh1750fvi/Settings.StyleCop

+112
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
<StyleCopSettings Version="105">
2+
<Analyzers>
3+
<Analyzer AnalyzerId="StyleCop.CSharp.DocumentationRules">
4+
<Rules>
5+
<Rule Name="FileHeaderMustContainFileName">
6+
<RuleSettings>
7+
<BooleanProperty Name="Enabled">False</BooleanProperty>
8+
</RuleSettings>
9+
</Rule>
10+
<Rule Name="FileHeaderMustHaveValidCompanyText">
11+
<RuleSettings>
12+
<BooleanProperty Name="Enabled">False</BooleanProperty>
13+
</RuleSettings>
14+
</Rule>
15+
<Rule Name="FileHeaderFileNameDocumentationMustMatchTypeName">
16+
<RuleSettings>
17+
<BooleanProperty Name="Enabled">False</BooleanProperty>
18+
</RuleSettings>
19+
</Rule>
20+
<Rule Name="PropertyDocumentationMustHaveValueText">
21+
<RuleSettings>
22+
<BooleanProperty Name="Enabled">True</BooleanProperty>
23+
</RuleSettings>
24+
</Rule>
25+
<Rule Name="DocumentationTextMustBeginWithACapitalLetter">
26+
<RuleSettings>
27+
<BooleanProperty Name="Enabled">True</BooleanProperty>
28+
</RuleSettings>
29+
</Rule>
30+
<Rule Name="DocumentationTextMustEndWithAPeriod">
31+
<RuleSettings>
32+
<BooleanProperty Name="Enabled">True</BooleanProperty>
33+
</RuleSettings>
34+
</Rule>
35+
<Rule Name="FileHeaderMustShowCopyright">
36+
<RuleSettings>
37+
<BooleanProperty Name="Enabled">False</BooleanProperty>
38+
</RuleSettings>
39+
</Rule>
40+
<Rule Name="FileHeaderMustHaveCopyrightText">
41+
<RuleSettings>
42+
<BooleanProperty Name="Enabled">False</BooleanProperty>
43+
</RuleSettings>
44+
</Rule>
45+
<Rule Name="ElementDocumentationMustBeSpelledCorrectly">
46+
<RuleSettings>
47+
<BooleanProperty Name="Enabled">False</BooleanProperty>
48+
</RuleSettings>
49+
</Rule>
50+
<Rule Name="DocumentationTextMustContainWhitespace">
51+
<RuleSettings>
52+
<BooleanProperty Name="Enabled">False</BooleanProperty>
53+
</RuleSettings>
54+
</Rule>
55+
</Rules>
56+
<AnalyzerSettings>
57+
<BooleanProperty Name="IgnorePrivates">True</BooleanProperty>
58+
<BooleanProperty Name="IgnoreInternals">True</BooleanProperty>
59+
</AnalyzerSettings>
60+
</Analyzer>
61+
<Analyzer AnalyzerId="StyleCop.CSharp.ReadabilityRules">
62+
<Rules>
63+
<Rule Name="PrefixLocalCallsWithThis">
64+
<RuleSettings>
65+
<BooleanProperty Name="Enabled">False</BooleanProperty>
66+
</RuleSettings>
67+
</Rule>
68+
<Rule Name="PrefixCallsCorrectly">
69+
<RuleSettings>
70+
<BooleanProperty Name="Enabled">False</BooleanProperty>
71+
</RuleSettings>
72+
</Rule>
73+
</Rules>
74+
<AnalyzerSettings />
75+
</Analyzer>
76+
<Analyzer AnalyzerId="StyleCop.CSharp.OrderingRules">
77+
<Rules>
78+
<Rule Name="UsingDirectivesMustBePlacedWithinNamespace">
79+
<RuleSettings>
80+
<BooleanProperty Name="Enabled">False</BooleanProperty>
81+
</RuleSettings>
82+
</Rule>
83+
<Rule Name="ElementsMustAppearInTheCorrectOrder">
84+
<RuleSettings>
85+
<BooleanProperty Name="Enabled">False</BooleanProperty>
86+
</RuleSettings>
87+
</Rule>
88+
<Rule Name="ElementsMustBeOrderedByAccess">
89+
<RuleSettings>
90+
<BooleanProperty Name="Enabled">False</BooleanProperty>
91+
</RuleSettings>
92+
</Rule>
93+
</Rules>
94+
<AnalyzerSettings />
95+
</Analyzer>
96+
<Analyzer AnalyzerId="StyleCop.CSharp.NamingRules">
97+
<Rules>
98+
<Rule Name="FieldNamesMustNotBeginWithUnderscore">
99+
<RuleSettings>
100+
<BooleanProperty Name="Enabled">False</BooleanProperty>
101+
</RuleSettings>
102+
</Rule>
103+
<Rule Name="FieldNamesMustNotUseHungarianNotation">
104+
<RuleSettings>
105+
<BooleanProperty Name="Enabled">False</BooleanProperty>
106+
</RuleSettings>
107+
</Rule>
108+
</Rules>
109+
<AnalyzerSettings />
110+
</Analyzer>
111+
</Analyzers>
112+
</StyleCopSettings>

‎devices/Bh1750fvi/packages.config

+1
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,5 @@
66
<package id="nanoFramework.System.Device.Model" version="1.2.82" targetFramework="netnanoframework10" />
77
<package id="Nerdbank.GitVersioning" version="3.5.113" developmentDependency="true" targetFramework="netnanoframework10" />
88
<package id="UnitsNet.nanoFramework.Illuminance" version="4.145.0" targetFramework="netnanoframework10" />
9+
<package id="StyleCop.MSBuild" version="6.2.0" targetFramework="netnano1.0" developmentDependency="true" />
910
</packages>

0 commit comments

Comments
 (0)