Add xml documentation

Kapil Borle · Kapil Borle · commit b489eaf1291d · 2017-07-07T13:40:03.000-07:00
diff --git a/Rules/UseIdenticalMandatoryParametersDSC.cs b/Rules/UseIdenticalMandatoryParametersDSC.cs
@@ -44,14 +44,17 @@ public class UseIdenticalMandatoryParametersDSC : IDSCResourceRule
         private IEnumerable<FunctionDefinitionAst> resourceFunctions;
         private Func<string, Tuple<string, Version>, Collection<Exception>, List<CimClass>> dscClassImporter;
 
+        /// <summary>
+        /// Constructs an object of type UseIdenticalMandatoryParametersDSC
+        /// </summary>
         public UseIdenticalMandatoryParametersDSC()
         {
             var importClassesMethod = typeof(DscClassCache).GetMethod(
                 "ImportClasses",
                 BindingFlags.Public | BindingFlags.Static);
             if (importClassesMethod != null)
             {
-                // In some version of S.M.A ImportClasses classes method takes 4 parameters
+                // In some version of S.M.A DscClassCache.ImportClasses method takes 4 parameters
                 // while in others it takes 3.
                 if (importClassesMethod.GetParameters().Count() == 4)
                 {

Original file line number	Diff line number	Diff line change
`@@ -44,14 +44,17 @@ public class UseIdenticalMandatoryParametersDSC : IDSCResourceRule`
`44`	`44`	`private IEnumerable<FunctionDefinitionAst> resourceFunctions;`
`45`	`45`	`private Func<string, Tuple<string, Version>, Collection<Exception>, List<CimClass>> dscClassImporter;`
`46`	`46`
	`47`	`+ /// <summary>`
	`48`	`+ /// Constructs an object of type UseIdenticalMandatoryParametersDSC`
	`49`	`+ /// </summary>`
`47`	`50`	`public UseIdenticalMandatoryParametersDSC()`
`48`	`51`	`{`
`49`	`52`	`var importClassesMethod = typeof(DscClassCache).GetMethod(`
`50`	`53`	`"ImportClasses",`
`51`	`54`	`BindingFlags.Public \| BindingFlags.Static);`
`52`	`55`	`if (importClassesMethod != null)`
`53`	`56`	`{`
`54`		`- // In some version of S.M.A ImportClasses classes method takes 4 parameters`
	`57`	`+ // In some version of S.M.A DscClassCache.ImportClasses method takes 4 parameters`
`55`	`58`	`// while in others it takes 3.`
`56`	`59`	`if (importClassesMethod.GetParameters().Count() == 4)`
`57`	`60`	`{`