More Docs update by Ken Foskey !!! (Thanks dude !!)

git-svn-id: svn://localhost/trunk@813 fafefce7-770d-0410-b8bf-a6f642d37c66

Author: MarcosMeli

FileHelpers/Core/IFieldInfoCacheManipulator.cs

@@ -268,19 +268,7 @@ public static IEnumerable<FieldInfo> RecursiveGetFields(Type currentType)
 
             FieldInfoCacheManipulator.ResetFieldInfoCache(currentType);
 
-            //var temp = currentType.GetMembers(BindingFlags.Public |
-            //                                  BindingFlags.NonPublic |
-            //                                  BindingFlags.Instance |
-            //                                  BindingFlags.GetField |
-            //                                  BindingFlags.GetProperty |
-            //                                  BindingFlags.DeclaredOnly);
-
-            //Debug.WriteLine(temp.Length);
-
-            //Array.Sort(temp, (x, y) => x.MetadataToken.CompareTo(y.MetadataToken));
-
-            //Debug.WriteLine(temp.Length);
-
+          
             foreach (FieldInfo fi in currentType.GetFields(BindingFlags.Public |
                                                            BindingFlags.NonPublic |
                                                            BindingFlags.Instance |

FileHelpers/Core/ReflectionHelper.cs

@@ -14,19 +14,19 @@ namespace FileHelpers
     [EditorBrowsable(EditorBrowsableState.Advanced)]
     public sealed class RecordIndexer
         :IEnumerable<string> 
-        //, INotifyRead
     {
-
+        /// <summary>
+        /// Get the record indexer,  engine will load the lines into an array
+        /// </summary>
         internal RecordIndexer()
         {}
 
         [FieldQuoted(QuoteMode.OptionalForRead, MultilineMode.AllowForRead)]
-        private string[] values;
+        private string[] values = null;
 
         /// <summary>
         /// The number of fields in the record
         /// </summary>
- 
         public int FieldCount
         {
             get { return values.Length; }
@@ -45,12 +45,19 @@ public string this[int index]
             }
         }
 
-
+        /// <summary>
+        /// Get the enumerator of the list
+        /// </summary>
+        /// <returns></returns>
         IEnumerator<string> IEnumerable<string>.GetEnumerator()
         {
             return new ArrayEnumerator(values);
         }
 
+        /// <summary>
+        /// Get enumerator of the list
+        /// </summary>
+        /// <returns></returns>
         IEnumerator IEnumerable.GetEnumerator()
         {
             return ((IEnumerable<string>) this).GetEnumerator();
@@ -69,26 +76,51 @@ IEnumerator IEnumerable.GetEnumerator()
 
         #region "  ArrayEnumerator  "
 
+        /// <summary>
+        /// Create an enumerator off an array of strings
+        /// </summary>
         private sealed class ArrayEnumerator : IEnumerator<string>
         {
+            /// <summary>
+            /// Array to return one at a time
+            /// </summary>
             private string[] mValues;
+
+            /// <summary>
+            /// Position in enumerator,  -1 to start
+            /// </summary>
             private int i;
+
+            /// <summary>
+            /// Create an enumerator off a string array
+            /// </summary>
+            /// <param name="values">values to return one at a time</param>
             public ArrayEnumerator(string[] values)
             {
                 mValues = values;
                 i = -1;
             }
 
+            /// <summary>
+            /// Get the current item we are working on
+            /// </summary>
             string IEnumerator<string>.Current
             {
                 get { return mValues[i]; }
             }
 
+            /// <summary>
+            /// Clean up not needed
+            /// </summary>
             public void Dispose()
             {
 
             }
 
+            /// <summary>
+            /// move the pointer along
+            /// </summary>
+            /// <returns></returns>
             public bool MoveNext()
             {
                 i++;
@@ -99,11 +131,17 @@ public bool MoveNext()
                 return true;
             }
 
+            /// <summary>
+            /// Go back to the start
+            /// </summary>
             public void Reset()
             {
                 i = -1;
             }
 
+            /// <summary>
+            /// Get the current element
+            /// </summary>
             public object Current
             {
                 get { return mValues[i]; }

FileHelpers/Csv/RecordIndexer.cs

@@ -1,31 +1,51 @@
-
-
 using System;
 using System.Text;
 
 namespace FileHelpers.Dynamic
 {
 
+    /// <summary>
+    /// Create attributes in the specified language and return as text to paste
+    /// into code
+    /// </summary>
 	internal sealed class AttributesBuilder
 	{
+        /// <summary>
+        /// Attribute text is created here...
+        /// </summary>
 		StringBuilder mSb = new StringBuilder(250);
-		NetLanguage mLeng;
+
+        /// <summary>
+        /// C# or Visual Basic
+        /// </summary>
+		NetLanguage mLang;
 
+        /// <summary>
+        /// Create an attribute in the language selected
+        /// </summary>
+        /// <param name="lang"></param>
 		public AttributesBuilder(NetLanguage lang)
 		{
-			mLeng = lang;
+			mLang = lang;
 		}
 
+        /// <summary>
+        /// Do we have any attributes, do we have to start and close VB attributes?
+        /// </summary>
 		private bool mFirst = true;
-		
+
+		/// <summary>
+		/// Add an attribute,  C#  [att1] [att2],  VB   &lt;att1,_att2
+		/// </summary>
+		/// <param name="attribute"></param>
 		public void AddAttribute(string attribute)
 		{
 			if (attribute == null || attribute == string.Empty)
 				return;
 
 			if (mFirst)
 			{
-				switch(mLeng)
+				switch(mLang)
 				{
 					case NetLanguage.CSharp:
 						mSb.Append("[");
@@ -38,10 +58,10 @@ public void AddAttribute(string attribute)
 			}
 			else
 			{
-				switch(mLeng)
+				switch(mLang)
 				{
 					case NetLanguage.VbNet:
-						mSb.Append(", _");
+						mSb.Append(", _"); //  new line continuation
 						mSb.Append(StringHelper.NewLine);
                         mSb.Append(" ");
 						break;
@@ -53,7 +73,7 @@ public void AddAttribute(string attribute)
 
 			mSb.Append(attribute);
 
-			switch(mLeng)
+			switch(mLang)
 			{
 				case NetLanguage.CSharp:
 					mSb.Append("]");
@@ -66,12 +86,16 @@ public void AddAttribute(string attribute)
 
 		}
 
+        /// <summary>
+        /// Return all of attributes as text, if first then it is empty
+        /// </summary>
+        /// <returns></returns>
 		public string GetAttributesCode()
 		{
 			if (mFirst == true)
 				return string.Empty;
 
-			switch(mLeng)
+			switch(mLang)
 			{
 				case NetLanguage.VbNet:
 					mSb.Append("> _");