Skip to content

Commit ff0c886

Browse files
committed
Fix Intellisense comments
1 parent c01f05e commit ff0c886

File tree

1 file changed

+34
-27
lines changed

1 file changed

+34
-27
lines changed

nanoFramework.System.Text/Text/StringBuilder.cs

Lines changed: 34 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,16 @@
77
namespace System.Text
88
{
99
/// <summary>
10-
/// A Micro Framework port of the Full Framework StringBuilder. Contributed by Julius Friedman.
1110
/// Represents a mutable string of characters. This class cannot be inherited.
1211
/// </summary>
12+
/// <remarks>
13+
/// <para>
14+
/// This is a port of the full .NET Framework <see cref="StringBuilder"/> class.
15+
/// </para>
16+
/// <para>
17+
/// Contributed to the .NETMF code base by Julius Friedman.
18+
/// </para>
19+
/// </remarks>
1320
public sealed class StringBuilder
1421
{
1522
#region Fields
@@ -173,12 +180,12 @@ public int Length
173180
#region Constructor
174181

175182
/// <summary>
176-
/// Initializes a new instance of the StringBuilder class from the specified substring and capacity.
183+
/// Initializes a new instance of the <see cref="StringBuilder"/> class from the specified substring and capacity.
177184
/// </summary>
178185
/// <param name="value">The string that contains the substring used to initialize the value of this instance. If value is null, the new StringBuilder will contain the empty string (that is, it contains Empty).</param>
179186
/// <param name="startIndex">The position within value where the substring begins.</param>
180187
/// <param name="length">The number of characters in the substring.</param>
181-
/// <param name="capacity">The suggested starting size of the StringBuilder.</param>
188+
/// <param name="capacity">The suggested starting size of the <see cref="StringBuilder"/>.</param>
182189
public unsafe StringBuilder(string value, int startIndex, int length, int capacity)
183190
{
184191
if (capacity < 0) throw new ArgumentOutOfRangeException("capacity");
@@ -209,17 +216,17 @@ private StringBuilder(int size, int maxCapacity, StringBuilder previousBlock)
209216
}
210217

211218
/// <summary>
212-
/// Initializes a new instance of the StringBuilder class using the specified string and capacity.
219+
/// Initializes a new instance of the <see cref="StringBuilder"/> class using the specified string and capacity.
213220
/// </summary>
214221
/// <param name="value">The string used to initialize the value of the instance. If value is null, the new StringBuilder will contain the empty string (that is, it contains Empty).</param>
215-
/// <param name="capacity">The suggested starting size of the StringBuilder.</param>
222+
/// <param name="capacity">The suggested starting size of the <see cref="StringBuilder"/>.</param>
216223
public StringBuilder(string value, int capacity)
217224
: this(value, 0, value != null ? value.Length : 0, capacity) { }
218225

219226
/// <summary>
220-
/// Initializes a new instance of the StringBuilder class that starts with a specified capacity and can grow to a specified maximum.
227+
/// Initializes a new instance of the <see cref="StringBuilder"/> class that starts with a specified capacity and can grow to a specified maximum.
221228
/// </summary>
222-
/// <param name="capacity">The suggested starting size of the StringBuilder.</param>
229+
/// <param name="capacity">The suggested starting size of the <see cref="StringBuilder"/>.</param>
223230
/// <param name="maxCapacity">The maximum number of characters the current string can contain.</param>
224231
public StringBuilder(int capacity, int maxCapacity)
225232
{
@@ -241,21 +248,21 @@ private StringBuilder(StringBuilder from)
241248
}
242249

243250
/// <summary>
244-
/// Initializes a new instance of the StringBuilder class using the specified capacity.
251+
/// Initializes a new instance of the <see cref="StringBuilder"/> class using the specified capacity.
245252
/// </summary>
246253
/// <param name="capacity">The suggested starting size of this instance.</param>
247254
public StringBuilder(int capacity)
248255
: this(string.Empty, capacity) { }
249256

250257
/// <summary>
251-
/// Initializes a new instance of the StringBuilder class using the specified string.
258+
/// Initializes a new instance of the <see cref="StringBuilder"/> class using the specified string.
252259
/// </summary>
253-
/// <param name="value">The string used to initialize the value of the instance. If value is null, the new StringBuilder will contain the empty string (that is, it contains Empty).</param>
260+
/// <param name="value">The string used to initialize the value of the instance. If value is <see langword="null"/>, the new <see cref="StringBuilder"/> will contain the empty string (that is, it contains <see cref="String.Empty"/>).</param>
254261
public StringBuilder(string value)
255262
: this(value, 0x10) { }
256263

257264
/// <summary>
258-
/// Initializes a new instance of the StringBuilder class.
265+
/// Initializes a new instance of the <see cref="StringBuilder"/> class.
259266
/// </summary>
260267
public StringBuilder()
261268
: this(0x10) { }
@@ -265,19 +272,19 @@ public StringBuilder()
265272
#region Methods
266273

267274
/// <summary>
268-
/// Removes all characters from the current StringBuilder instance.
275+
/// Removes all characters from the current <see cref="StringBuilder"/> instance.
269276
/// </summary>
270-
/// <returns>An object whose Length is 0 (zero).</returns>
277+
/// <returns>An object whose <see cref="Length"/> is 0 (zero).</returns>
271278
public StringBuilder Clear()
272279
{
273280
Length = 0;
274281
return this;
275282
}
276283

277284
/// <summary>
278-
/// Appends the string representation of a specified Boolean value to this instance.
285+
/// Appends the string representation of a specified <see cref="bool"/> value to this instance.
279286
/// </summary>
280-
/// <param name="value">The Boolean value to append.</param>
287+
/// <param name="value">The <see cref="bool"/> value to append.</param>
281288
/// <returns>A reference to this instance after the append operation has completed.</returns>
282289
public StringBuilder Append(bool value)
283290
{
@@ -582,7 +589,7 @@ public StringBuilder Remove(int startIndex, int length)
582589
}
583590

584591
/// <summary>
585-
/// Converts the value of this instance to a String. (Overrides Object.ToString().)
592+
/// Converts the value of this instance to a String. (Overrides <see cref="Object.ToString"/>().)
586593
/// </summary>
587594
/// <returns>A string whose value is the same as this instance.</returns>
588595
public override string ToString()
@@ -722,10 +729,10 @@ public StringBuilder Insert(int index, char[] value, int startIndex, int charCou
722729
/// Replaces, within a substring of this instance, all occurrences of a specified character with another specified character.
723730
/// </summary>
724731
/// <param name="oldChar">The character to replace. </param>
725-
/// <param name="newChar">The character that replaces oldChar. </param>
726-
/// <param name="startIndex">The position in this instance where the substring begins. </param>
732+
/// <param name="newChar">The character that replaces <paramref name="oldChar"/>. </param>
733+
/// <param name="startIndex">The position in this instance where the substring begins.</param>
727734
/// <param name="count">The length of the substring. </param>
728-
/// <returns>A reference to this instance with oldChar replaced by newChar in the range from startIndex to startIndex + count -1.</returns>
735+
/// <returns>A reference to this instance with <paramref name="oldChar"/> replaced by <paramref name="newChar"/> in the range from <paramref name="startIndex"/> to <paramref name="startIndex"/> + <paramref name="count"/> - 1.</returns>
729736
public StringBuilder Replace(char oldChar, char newChar, int startIndex, int count)
730737
{
731738
var length = Length;
@@ -762,8 +769,8 @@ public StringBuilder Replace(char oldChar, char newChar, int startIndex, int cou
762769
/// Replaces all occurrences of a specified character in this instance with another specified character.
763770
/// </summary>
764771
/// <param name="oldChar">The character to replace.</param>
765-
/// <param name="newChar">The character that replaces oldChar.</param>
766-
/// <returns>A reference to this instance with oldChar replaced by newChar.</returns>
772+
/// <param name="newChar">The character that replaces <paramref name="oldChar"/>.</param>
773+
/// <returns>A reference to this instance with <paramref name="oldChar"/> replaced by <paramref name="newChar"/>.</returns>
767774
public StringBuilder Replace(char oldChar, char newChar)
768775
{
769776
return Replace(oldChar, newChar, 0, Length);
@@ -773,10 +780,10 @@ public StringBuilder Replace(char oldChar, char newChar)
773780
/// Replaces, within a substring of this instance, all occurrences of a specified string with another specified string.
774781
/// </summary>
775782
/// <param name="oldValue">The string to replace.</param>
776-
/// <param name="newValue">The string that replaces oldValue, or null.</param>
783+
/// <param name="newValue">The string that replaces <paramref name="oldValue"/>, or <see langword="null"/>.</param>
777784
/// <param name="startIndex">The position in this instance where the substring begins.</param>
778785
/// <param name="count">The length of the substring.</param>
779-
/// <returns>A reference to this instance with all instances of oldValue replaced by newValue in the range from startIndex to startIndex + count - 1.</returns>
786+
/// <returns>A reference to this instance with all instances of <paramref name="oldValue"/> replaced by <paramref name="newValue"/> in the range from <paramref name="startIndex"/> to <paramref name="startIndex"/> + <paramref name="count"/> - 1.</returns>
780787
public StringBuilder Replace(string oldValue, string newValue, int startIndex, int count)
781788
{
782789
var length = Length;
@@ -851,15 +858,15 @@ public StringBuilder Replace(string oldValue, string newValue, int startIndex, i
851858
/// Replaces all occurrences of a specified string in this instance with another specified string.
852859
/// </summary>
853860
/// <param name="oldValue">The string to replace.</param>
854-
/// <param name="newValue">The string that replaces oldValue, or null.</param>
855-
/// <returns>A reference to this instance with all instances of oldValue replaced by newValue.</returns>
861+
/// <param name="newValue">The string that replaces <paramref name="oldValue"/>, or <see langword="null"/>.</param>
862+
/// <returns>A reference to this instance with all instances of <paramref name="oldValue"/> replaced by <paramref name="newValue"/>.</returns>
856863
public StringBuilder Replace(string oldValue, string newValue)
857864
{
858865
return Replace(oldValue, newValue, 0, Length);
859866
}
860867

861868
/// <summary>
862-
/// Appends a copy of the specified string followed by the default line terminator to the end of the current StringBuilder object.
869+
/// Appends a copy of the specified string followed by the default line terminator to the end of the current <see cref="StringBuilder"/> object.
863870
/// </summary>
864871
/// <param name="str">A reference to this instance after the append operation has completed.</param>
865872
public StringBuilder AppendLine(string str)
@@ -869,7 +876,7 @@ public StringBuilder AppendLine(string str)
869876
}
870877

871878
/// <summary>
872-
/// Appends the default line terminator to the end of the current StringBuilder object.
879+
/// Appends the default line terminator to the end of the current <see cref="StringBuilder"/> object.
873880
/// </summary>
874881
/// <returns>A reference to this instance after the append operation has completed.</returns>
875882
public StringBuilder AppendLine()

0 commit comments

Comments
 (0)