Skip to content

Commit a53aa47

Browse files
jonathanbennett73jonathanbennett73
committed
Updated to corefx naming standards and added function documentation.
1 parent 248e53c commit a53aa47

File tree

4 files changed

+474
-236
lines changed

4 files changed

+474
-236
lines changed

‎TextEncodingDetect-C#/TextEncodingDetect/Program.cs‎

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
//
2-
// Copyright 2015 Jonathan Bennett <[email protected]>
1+
// Copyright 2015-2016 Jonathan Bennett <[email protected]>
32
//
43
// https://www.autoitscript.com
54
//
@@ -14,15 +13,10 @@
1413
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1514
// See the License for the specific language governing permissions and
1615
// limitations under the License.
17-
//
1816

1917
using System;
20-
using System.Collections.Generic;
2118
using System.IO;
22-
using System.Linq;
23-
using System.Text;
24-
using System.Threading.Tasks;
25-
using AutoIt.Text;
19+
using AutoIt.Common;
2620

2721
public class Program
2822
{
@@ -58,23 +52,23 @@ public static int Main(string[] args)
5852
{
5953
Console.WriteLine("Binary");
6054
}
61-
else if (encoding == TextEncodingDetect.Encoding.ASCII)
55+
else if (encoding == TextEncodingDetect.Encoding.Ascii)
6256
{
6357
Console.WriteLine("ASCII (chars in the 0-127 range)");
6458
}
65-
else if (encoding == TextEncodingDetect.Encoding.ANSI)
59+
else if (encoding == TextEncodingDetect.Encoding.Ansi)
6660
{
6761
Console.WriteLine("ANSI (chars in the range 0-255 range)");
6862
}
69-
else if (encoding == TextEncodingDetect.Encoding.UTF8_BOM || encoding == TextEncodingDetect.Encoding.UTF8_NOBOM)
63+
else if (encoding == TextEncodingDetect.Encoding.Utf8Bom || encoding == TextEncodingDetect.Encoding.Utf8Nobom)
7064
{
7165
Console.WriteLine("UTF-8");
7266
}
73-
else if (encoding == TextEncodingDetect.Encoding.UTF16_LE_BOM || encoding == TextEncodingDetect.Encoding.UTF16_LE_NOBOM)
67+
else if (encoding == TextEncodingDetect.Encoding.Utf16LeBom || encoding == TextEncodingDetect.Encoding.Utf16LeNoBom)
7468
{
7569
Console.WriteLine("UTF-16 Little Endian");
7670
}
77-
else if (encoding == TextEncodingDetect.Encoding.UTF16_BE_BOM || encoding == TextEncodingDetect.Encoding.UTF16_BE_NOBOM)
71+
else if (encoding == TextEncodingDetect.Encoding.Utf16BeBom || encoding == TextEncodingDetect.Encoding.Utf16BeNoBom)
7872
{
7973
Console.WriteLine("UTF-16 Big Endian");
8074
}

‎TextEncodingDetect-C#/TextEncodingDetect/Settings.StyleCop‎

Lines changed: 248 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
<BooleanProperty Name="Enabled">False</BooleanProperty>
1515
</RuleSettings>
1616
</Rule>
17-
<Rule Name="PartialElementsMustBeDocumented">
17+
<Rule Name="FileMustHaveHeader">
1818
<RuleSettings>
1919
<BooleanProperty Name="Enabled">False</BooleanProperty>
2020
</RuleSettings>
@@ -24,7 +24,237 @@
2424
<BooleanProperty Name="Enabled">False</BooleanProperty>
2525
</RuleSettings>
2626
</Rule>
27-
<Rule Name="FileMustHaveHeader">
27+
<Rule Name="PartialElementsMustBeDocumented">
28+
<RuleSettings>
29+
<BooleanProperty Name="Enabled">False</BooleanProperty>
30+
</RuleSettings>
31+
</Rule>
32+
<Rule Name="DocumentationMustContainValidXml">
33+
<RuleSettings>
34+
<BooleanProperty Name="Enabled">False</BooleanProperty>
35+
</RuleSettings>
36+
</Rule>
37+
<Rule Name="ElementDocumentationMustHaveSummary">
38+
<RuleSettings>
39+
<BooleanProperty Name="Enabled">False</BooleanProperty>
40+
</RuleSettings>
41+
</Rule>
42+
<Rule Name="PartialElementDocumentationMustHaveSummary">
43+
<RuleSettings>
44+
<BooleanProperty Name="Enabled">False</BooleanProperty>
45+
</RuleSettings>
46+
</Rule>
47+
<Rule Name="ElementDocumentationMustHaveSummaryText">
48+
<RuleSettings>
49+
<BooleanProperty Name="Enabled">False</BooleanProperty>
50+
</RuleSettings>
51+
</Rule>
52+
<Rule Name="PartialElementDocumentationMustHaveSummaryText">
53+
<RuleSettings>
54+
<BooleanProperty Name="Enabled">False</BooleanProperty>
55+
</RuleSettings>
56+
</Rule>
57+
<Rule Name="ElementDocumentationMustNotHaveDefaultSummary">
58+
<RuleSettings>
59+
<BooleanProperty Name="Enabled">False</BooleanProperty>
60+
</RuleSettings>
61+
</Rule>
62+
<Rule Name="ElementParametersMustBeDocumented">
63+
<RuleSettings>
64+
<BooleanProperty Name="Enabled">False</BooleanProperty>
65+
</RuleSettings>
66+
</Rule>
67+
<Rule Name="ElementParameterDocumentationMustMatchElementParameters">
68+
<RuleSettings>
69+
<BooleanProperty Name="Enabled">False</BooleanProperty>
70+
</RuleSettings>
71+
</Rule>
72+
<Rule Name="ElementParameterDocumentationMustDeclareParameterName">
73+
<RuleSettings>
74+
<BooleanProperty Name="Enabled">False</BooleanProperty>
75+
</RuleSettings>
76+
</Rule>
77+
<Rule Name="ElementParameterDocumentationMustHaveText">
78+
<RuleSettings>
79+
<BooleanProperty Name="Enabled">False</BooleanProperty>
80+
</RuleSettings>
81+
</Rule>
82+
<Rule Name="ElementReturnValueMustBeDocumented">
83+
<RuleSettings>
84+
<BooleanProperty Name="Enabled">False</BooleanProperty>
85+
</RuleSettings>
86+
</Rule>
87+
<Rule Name="ElementReturnValueDocumentationMustHaveText">
88+
<RuleSettings>
89+
<BooleanProperty Name="Enabled">False</BooleanProperty>
90+
</RuleSettings>
91+
</Rule>
92+
<Rule Name="VoidReturnValueMustNotBeDocumented">
93+
<RuleSettings>
94+
<BooleanProperty Name="Enabled">False</BooleanProperty>
95+
</RuleSettings>
96+
</Rule>
97+
<Rule Name="GenericTypeParametersMustBeDocumented">
98+
<RuleSettings>
99+
<BooleanProperty Name="Enabled">False</BooleanProperty>
100+
</RuleSettings>
101+
</Rule>
102+
<Rule Name="GenericTypeParametersMustBeDocumentedPartialClass">
103+
<RuleSettings>
104+
<BooleanProperty Name="Enabled">False</BooleanProperty>
105+
</RuleSettings>
106+
</Rule>
107+
<Rule Name="GenericTypeParameterDocumentationMustMatchTypeParameters">
108+
<RuleSettings>
109+
<BooleanProperty Name="Enabled">False</BooleanProperty>
110+
</RuleSettings>
111+
</Rule>
112+
<Rule Name="GenericTypeParameterDocumentationMustDeclareParameterName">
113+
<RuleSettings>
114+
<BooleanProperty Name="Enabled">False</BooleanProperty>
115+
</RuleSettings>
116+
</Rule>
117+
<Rule Name="GenericTypeParameterDocumentationMustHaveText">
118+
<RuleSettings>
119+
<BooleanProperty Name="Enabled">False</BooleanProperty>
120+
</RuleSettings>
121+
</Rule>
122+
<Rule Name="PropertySummaryDocumentationMustMatchAccessors">
123+
<RuleSettings>
124+
<BooleanProperty Name="Enabled">False</BooleanProperty>
125+
</RuleSettings>
126+
</Rule>
127+
<Rule Name="PropertySummaryDocumentationMustOmitSetAccessorWithRestrictedAccess">
128+
<RuleSettings>
129+
<BooleanProperty Name="Enabled">False</BooleanProperty>
130+
</RuleSettings>
131+
</Rule>
132+
<Rule Name="ElementDocumentationMustNotBeCopiedAndPasted">
133+
<RuleSettings>
134+
<BooleanProperty Name="Enabled">False</BooleanProperty>
135+
</RuleSettings>
136+
</Rule>
137+
<Rule Name="SingleLineCommentsMustNotUseDocumentationStyleSlashes">
138+
<RuleSettings>
139+
<BooleanProperty Name="Enabled">False</BooleanProperty>
140+
</RuleSettings>
141+
</Rule>
142+
<Rule Name="DocumentationTextMustNotBeEmpty">
143+
<RuleSettings>
144+
<BooleanProperty Name="Enabled">False</BooleanProperty>
145+
</RuleSettings>
146+
</Rule>
147+
<Rule Name="DocumentationTextMustContainWhitespace">
148+
<RuleSettings>
149+
<BooleanProperty Name="Enabled">False</BooleanProperty>
150+
</RuleSettings>
151+
</Rule>
152+
<Rule Name="DocumentationMustMeetCharacterPercentage">
153+
<RuleSettings>
154+
<BooleanProperty Name="Enabled">False</BooleanProperty>
155+
</RuleSettings>
156+
</Rule>
157+
<Rule Name="ConstructorSummaryDocumentationMustBeginWithStandardText">
158+
<RuleSettings>
159+
<BooleanProperty Name="Enabled">False</BooleanProperty>
160+
</RuleSettings>
161+
</Rule>
162+
<Rule Name="DestructorSummaryDocumentationMustBeginWithStandardText">
163+
<RuleSettings>
164+
<BooleanProperty Name="Enabled">False</BooleanProperty>
165+
</RuleSettings>
166+
</Rule>
167+
<Rule Name="DocumentationHeadersMustNotContainBlankLines">
168+
<RuleSettings>
169+
<BooleanProperty Name="Enabled">False</BooleanProperty>
170+
</RuleSettings>
171+
</Rule>
172+
<Rule Name="IncludedDocumentationXPathDoesNotExist">
173+
<RuleSettings>
174+
<BooleanProperty Name="Enabled">False</BooleanProperty>
175+
</RuleSettings>
176+
</Rule>
177+
<Rule Name="IncludeNodeDoesNotContainValidFileAndPath">
178+
<RuleSettings>
179+
<BooleanProperty Name="Enabled">False</BooleanProperty>
180+
</RuleSettings>
181+
</Rule>
182+
<Rule Name="InheritDocMustBeUsedWithInheritingClass">
183+
<RuleSettings>
184+
<BooleanProperty Name="Enabled">False</BooleanProperty>
185+
</RuleSettings>
186+
</Rule>
187+
<Rule Name="ElementDocumentationMustBeSpelledCorrectly">
188+
<RuleSettings>
189+
<BooleanProperty Name="Enabled">False</BooleanProperty>
190+
</RuleSettings>
191+
</Rule>
192+
<Rule Name="FileHeaderMustShowCopyright">
193+
<RuleSettings>
194+
<BooleanProperty Name="Enabled">False</BooleanProperty>
195+
</RuleSettings>
196+
</Rule>
197+
<Rule Name="FileHeaderMustHaveCopyrightText">
198+
<RuleSettings>
199+
<BooleanProperty Name="Enabled">False</BooleanProperty>
200+
</RuleSettings>
201+
</Rule>
202+
<Rule Name="FileHeaderMustContainFileName">
203+
<RuleSettings>
204+
<BooleanProperty Name="Enabled">False</BooleanProperty>
205+
</RuleSettings>
206+
</Rule>
207+
<Rule Name="FileHeaderFileNameDocumentationMustMatchFileName">
208+
<RuleSettings>
209+
<BooleanProperty Name="Enabled">False</BooleanProperty>
210+
</RuleSettings>
211+
</Rule>
212+
<Rule Name="FileHeaderMustHaveValidCompanyText">
213+
<RuleSettings>
214+
<BooleanProperty Name="Enabled">False</BooleanProperty>
215+
</RuleSettings>
216+
</Rule>
217+
<Rule Name="FileHeaderFileNameDocumentationMustMatchTypeName">
218+
<RuleSettings>
219+
<BooleanProperty Name="Enabled">False</BooleanProperty>
220+
</RuleSettings>
221+
</Rule>
222+
</Rules>
223+
<AnalyzerSettings />
224+
</Analyzer>
225+
<Analyzer AnalyzerId="StyleCop.CSharp.NamingRules">
226+
<Rules>
227+
<Rule Name="ConstFieldNamesMustBeginWithUpperCaseLetter">
228+
<RuleSettings>
229+
<BooleanProperty Name="Enabled">False</BooleanProperty>
230+
</RuleSettings>
231+
</Rule>
232+
<Rule Name="FieldNamesMustNotBeginWithUnderscore">
233+
<RuleSettings>
234+
<BooleanProperty Name="Enabled">False</BooleanProperty>
235+
</RuleSettings>
236+
</Rule>
237+
<Rule Name="FieldNamesMustNotUseHungarianNotation">
238+
<RuleSettings>
239+
<BooleanProperty Name="Enabled">False</BooleanProperty>
240+
</RuleSettings>
241+
</Rule>
242+
<Rule Name="FieldNamesMustNotContainUnderscore">
243+
<RuleSettings>
244+
<BooleanProperty Name="Enabled">False</BooleanProperty>
245+
</RuleSettings>
246+
</Rule>
247+
</Rules>
248+
<AnalyzerSettings>
249+
<CollectionProperty Name="Hungarian">
250+
<Value>cm</Value>
251+
<Value>dt</Value>
252+
</CollectionProperty>
253+
</AnalyzerSettings>
254+
</Analyzer>
255+
<Analyzer AnalyzerId="StyleCop.CSharp.OrderingRules">
256+
<Rules>
257+
<Rule Name="UsingDirectivesMustBePlacedWithinNamespace">
28258
<RuleSettings>
29259
<BooleanProperty Name="Enabled">False</BooleanProperty>
30260
</RuleSettings>
@@ -34,7 +264,22 @@
34264
</Analyzer>
35265
<Analyzer AnalyzerId="StyleCop.CSharp.ReadabilityRules">
36266
<Rules>
37-
<Rule Name="CommentsMustContainText">
267+
<Rule Name="PrefixLocalCallsWithThis">
268+
<RuleSettings>
269+
<BooleanProperty Name="Enabled">False</BooleanProperty>
270+
</RuleSettings>
271+
</Rule>
272+
<Rule Name="PrefixCallsCorrectly">
273+
<RuleSettings>
274+
<BooleanProperty Name="Enabled">False</BooleanProperty>
275+
</RuleSettings>
276+
</Rule>
277+
</Rules>
278+
<AnalyzerSettings />
279+
</Analyzer>
280+
<Analyzer AnalyzerId="StyleCop.CSharp.MaintainabilityRules">
281+
<Rules>
282+
<Rule Name="FileMayOnlyContainASingleClass">
38283
<RuleSettings>
39284
<BooleanProperty Name="Enabled">False</BooleanProperty>
40285
</RuleSettings>

0 commit comments

Comments
 (0)