Skip to content

Commit dfb6882

Browse files
BillWagnerjskeet
authored andcommitted
Add name attribute to param tags
Fixes dotnet#915 In the example in D5, add the "name=" attribute on all param tags.
1 parent 91c5179 commit dfb6882

File tree

1 file changed

+22
-22
lines changed

1 file changed

+22
-22
lines changed

standard/documentation-comments.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1031,8 +1031,8 @@ namespace Graphics
10311031
/// This constructor initializes the new Point to
10321032
/// (<paramref name="xPosition"/>,<paramref name="yPosition"/>).
10331033
/// </summary>
1034-
/// <param><c>xPosition</c> is the new Point's x-coordinate.</param>
1035-
/// <param><c>yPosition</c> is the new Point's y-coordinate.</param>
1034+
/// <param name="xPosition"><c>xPosition</c> is the new Point's x-coordinate.</param>
1035+
/// <param name="yPosition"><c>yPosition</c> is the new Point's y-coordinate.</param>
10361036
public Point(int xPosition, int yPosition)
10371037
{
10381038
X = xPosition;
@@ -1043,8 +1043,8 @@ namespace Graphics
10431043
/// This method changes the point's location to
10441044
/// the given coordinates. <see cref="Translate"/>
10451045
/// </summary>
1046-
/// <param><c>xPosition</c> is the new x-coordinate.</param>
1047-
/// <param><c>yPosition</c> is the new y-coordinate.</param>
1046+
/// <param name="xPosition"><c>xPosition</c> is the new x-coordinate.</param>
1047+
/// <param name="yPosition"><c>yPosition</c> is the new y-coordinate.</param>
10481048
public void Move(int xPosition, int yPosition)
10491049
{
10501050
X = xPosition;
@@ -1063,8 +1063,8 @@ namespace Graphics
10631063
/// <see cref="Move"/>
10641064
/// </example>
10651065
/// </summary>
1066-
/// <param><c>dx</c> is the relative x-offset.</param>
1067-
/// <param><c>dy</c> is the relative y-offset.</param>
1066+
/// <param name="dx"><c>dx</c> is the relative x-offset.</param>
1067+
/// <param name="dy"><c>dy</c> is the relative y-offset.</param>
10681068
public void Translate(int dx, int dy)
10691069
{
10701070
X += dx;
@@ -1074,7 +1074,7 @@ namespace Graphics
10741074
/// <summary>
10751075
/// This method determines whether two Points have the same location.
10761076
/// </summary>
1077-
/// <param>
1077+
/// <param name="o">
10781078
/// <c>o</c> is the object to be compared to the current object.
10791079
/// </param>
10801080
/// <returns>
@@ -1122,8 +1122,8 @@ namespace Graphics
11221122
/// <summary>
11231123
/// This operator determines whether two Points have the same location.
11241124
/// </summary>
1125-
/// <param><c>p1</c> is the first Point to be compared.</param>
1126-
/// <param><c>p2</c> is the second Point to be compared.</param>
1125+
/// <param name="p1"><c>p1</c> is the first Point to be compared.</param>
1126+
/// <param name="p2"><c>p2</c> is the second Point to be compared.</param>
11271127
/// <returns>
11281128
/// True if the Points have the same location and they have
11291129
/// the exact same type; otherwise, false.
@@ -1146,8 +1146,8 @@ namespace Graphics
11461146
/// <summary>
11471147
/// This operator determines whether two Points have the same location.
11481148
/// </summary>
1149-
/// <param><c>p1</c> is the first Point to be compared.</param>
1150-
/// <param><c>p2</c> is the second Point to be compared.</param>
1149+
/// <param name="p1"><c>p1</c> is the first Point to be compared.</param>
1150+
/// <param name="p2"><c>p2</c> is the second Point to be compared.</param>
11511151
/// <returns>
11521152
/// True if the Points do not have the same location and the
11531153
/// exact same type; otherwise, false.
@@ -1183,17 +1183,17 @@ Here is the output produced by one documentation generator when given the source
11831183
This constructor initializes the new Point to
11841184
(<paramref name="xPosition"/>,<paramref name="yPosition"/>).
11851185
</summary>
1186-
<param><c>xPosition</c> is the new Point's x-coordinate.</param>
1187-
<param><c>yPosition</c> is the new Point's y-coordinate.</param>
1186+
<param name="xPosition"><c>xPosition</c> is the new Point's x-coordinate.</param>
1187+
<param name="yPosition"><c>yPosition</c> is the new Point's y-coordinate.</param>
11881188
</member>
11891189
<member name="M:Graphics.Point.Move(System.Int32,System.Int32)">
11901190
<summary>
11911191
This method changes the point's location to
11921192
the given coordinates.
11931193
<see cref="M:Graphics.Point.Translate(System.Int32,System.Int32)"/>
11941194
</summary>
1195-
<param><c>xPosition</c> is the new x-coordinate.</param>
1196-
<param><c>yPosition</c> is the new y-coordinate.</param>
1195+
<param name="xPosition"><c>xPosition</c> is the new x-coordinate.</param>
1196+
<param name="yPosition"><c>yPosition</c> is the new y-coordinate.</param>
11971197
</member>
11981198
<member name="M:Graphics.Point.Translate(System.Int32,System.Int32)">
11991199
<summary>
@@ -1208,14 +1208,14 @@ Here is the output produced by one documentation generator when given the source
12081208
</example>
12091209
<see cref="M:Graphics.Point.Move(System.Int32,System.Int32)"/>
12101210
</summary>
1211-
<param><c>dx</c> is the relative x-offset.</param>
1212-
<param><c>dy</c> is the relative y-offset.</param>
1211+
<param name="dx"><c>dx</c> is the relative x-offset.</param>
1212+
<param name="dy"><c>dy</c> is the relative y-offset.</param>
12131213
</member>
12141214
<member name="M:Graphics.Point.Equals(System.Object)">
12151215
<summary>
12161216
This method determines whether two Points have the same location.
12171217
</summary>
1218-
<param>
1218+
<param name="o">
12191219
<c>o</c> is the object to be compared to the current object.
12201220
</param>
12211221
<returns>
@@ -1240,8 +1240,8 @@ Here is the output produced by one documentation generator when given the source
12401240
<summary>
12411241
This operator determines whether two Points have the same location.
12421242
</summary>
1243-
<param><c>p1</c> is the first Point to be compared.</param>
1244-
<param><c>p2</c> is the second Point to be compared.</param>
1243+
<param name="p1"><c>p1</c> is the first Point to be compared.</param>
1244+
<param name="p2"><c>p2</c> is the second Point to be compared.</param>
12451245
<returns>
12461246
True if the Points have the same location and they have
12471247
the exact same type; otherwise, false.
@@ -1255,8 +1255,8 @@ Here is the output produced by one documentation generator when given the source
12551255
<summary>
12561256
This operator determines whether two Points have the same location.
12571257
</summary>
1258-
<param><c>p1</c> is the first Point to be compared.</param>
1259-
<param><c>p2</c> is the second Point to be compared.</param>
1258+
<param name="p1"><c>p1</c> is the first Point to be compared.</param>
1259+
<param name="p2"><c>p2</c> is the second Point to be compared.</param>
12601260
<returns>
12611261
True if the Points do not have the same location and the
12621262
exact same type; otherwise, false.

0 commit comments

Comments
 (0)