Merge pull request dotnet/corefx#226 from alfaproject/xml-comments

Fix some XML comments

Commit migrated from https://github.com/dotnet/corefx/commit/691bfca2eed5feb9a2bbe4af1f10bd3ab35d2110

src/libraries/System.Console/src/System/ConsolePal.Unix.cs

@@ -347,7 +347,7 @@ public override void Write(byte[] buffer, int offset, int count)
         /// <summary>Provides access to and processing of the terminfo database.</summary>
         internal static class TermInfo
         {
-            /// <summar>Provides a terminfo database.</summary>
+            /// <summary>Provides a terminfo database.</summary>
             internal sealed class Database
             {
                 /// <summary>Lazily-initialized instance of the database.</summary>
@@ -530,7 +530,7 @@ public string GetString(int stringTableIndex)
                 }
 
                 /// <summary>Gets a number from the numbers section by the number's well-known index.</summary>
-                /// <param name="stringTableIndex">The index of the string to find.</param>
+                /// <param name="numberIndex">The index of the string to find.</param>
                 /// <returns>The number if it's in the database; otherwise, -1.</returns>
                 public int GetNumber(int numberIndex)
                 {
@@ -624,6 +624,7 @@ public static string Evaluate(string format, params FormatParam[] args)
 
                 /// <summary>Evaluates a terminfo formatting string, using the supplied arguments and processing data structures.</summary>
                 /// <param name="format">The format string.</param>
+                /// <param name="pos">The position in <paramref name="format"/> to start processing.</param>
                 /// <param name="args">The arguments to the format string.</param>
                 /// <param name="stack">The stack to use as the format string is evaluated.</param>
                 /// <param name="dynamicVars">A lazily-initialized collection of variables.</param>

src/libraries/System.Xml.XDocument/src/System/Xml/Linq/XDocument.cs

@@ -402,11 +402,12 @@ public static XDocument Parse(string text)
         /// XML.  Optionally whitespace can be preserved.
         /// </summary>
         /// <remarks>
-        /// This method uses <see cref="XmlReader.Create"/> method passing it a StringReader
-        /// constructed from the passed in XML String.  If LoadOptions.PreserveWhitespace
-        /// is enabled then <see cref="XmlReaderSettings.IgnoreWhitespace"/> is
-        /// set to false.  See <see cref="XmlReaderSettings.IgnoreWhitespace"/>
-        /// for more information on whitespace handling.
+        /// This method uses <see cref="XmlReader.Create(TextReader, XmlReaderSettings)"/>,
+        /// passing it a StringReader constructed from the passed in XML String. If
+        /// <see cref="LoadOptions.PreserveWhitespace"/> is enabled then
+        /// <see cref="XmlReaderSettings.IgnoreWhitespace"/> is set to false. See
+        /// <see cref="XmlReaderSettings.IgnoreWhitespace"/> for more information on
+        /// whitespace handling.
         /// </remarks>
         /// <param name="text">
         /// A string containing XML.

src/libraries/System.Xml.XDocument/src/System/Xml/Linq/XElement.cs

@@ -699,8 +699,8 @@ public static XElement Parse(string text)
         }
 
         /// <summary>
-        /// Parses a string containing XML into an <see cref="XElement"/> and 
-        /// optionally preserves the Whitespace.  See <see cref="XmlReaderSetting.IgnoreWhitespace"/>.
+        /// Parses a string containing XML into an <see cref="XElement"/> and optionally
+        /// preserves the Whitespace. See <see cref="XmlReaderSettings.IgnoreWhitespace"/>.
         /// </summary>
         /// <remarks>
         /// <list>
@@ -1039,10 +1039,10 @@ public void SetValue(object value)
         }
 
         /// <summary>
-        /// Write this <see cref="XElement"/> to the passed in <see cref="XmlTextWriter"/>.
+        /// Write this <see cref="XElement"/> to the passed in <see cref="XmlWriter"/>.
         /// </summary>
         /// <param name="writer">
-        /// The <see cref="XmlTextWriter"/> to write this <see cref="XElement"/> to.
+        /// The <see cref="XmlWriter"/> to write this <see cref="XElement"/> to.
         /// </param>
         public override void WriteTo(XmlWriter writer)
         {

src/libraries/System.Xml.XDocument/src/System/Xml/Linq/XNodeReader.cs

@@ -1304,7 +1304,7 @@ bool ReadToEnd()
         /// Determines if the specified attribute would be a duplicate namespace declaration
         ///  - one which we already reported on some ancestor, so it's not necessary to report it here
         /// </summary>
-        /// <param name="a">The attribute to test</param>
+        /// <param name="candidateAttribute">The attribute to test.</param>
         /// <returns>true if the attribute is a duplicate namespace declaration attribute</returns>
         bool IsDuplicateNamespaceAttribute(XAttribute candidateAttribute)
         {