@@ -34,7 +34,7 @@ In a *Delimited_Doc_Comment*, if the first non-*Whitespace* character on the sec
34
34
35
35
** Example:**
36
36
37
- <!-- Example: {template:"standalone-lib", name:"DCIntroduction", replaceEllipsis:true} -->
37
+ <!-- Example: {template:"standalone-lib-without-using ", name:"DCIntroduction", replaceEllipsis:true} -->
38
38
``` csharp
39
39
/// <summary >
40
40
/// Class <c >Point</c > models a point in a two-dimensional plane.
@@ -98,7 +98,7 @@ This tag provides a mechanism to indicate that a fragment of text within a descr
98
98
99
99
** Example:**
100
100
101
- <!-- Example: {template:"standalone-lib", name:"TagC"} -->
101
+ <!-- Example: {template:"standalone-lib-without-using ", name:"TagC"} -->
102
102
``` csharp
103
103
/// <summary >
104
104
/// Class <c >Point</c > models a point in a two-dimensional plane.
@@ -118,7 +118,7 @@ This tag is used to set one or more lines of source code or program output in so
118
118
119
119
** Example:**
120
120
121
- <!-- IncompleteExample : {template:"standalone-lib", name:"TagCode", ignoredWarnings:["CS1591"]} -->
121
+ <!-- Example : {template:"standalone-lib-without-using ", name:"TagCode", ignoredWarnings:["CS1591"], replaceEllipsis:true } -->
122
122
``` csharp
123
123
public class Point
124
124
{
@@ -167,7 +167,7 @@ where
167
167
168
168
** Example:**
169
169
170
- <!-- IncompleteExample : {template:"standalone-lib", name:"TagException", ignoredWarnings:["CS1591"]} -->
170
+ <!-- Example : {template:"standalone-lib-without-using ", name:"TagException", ignoredWarnings:["CS1591"], replaceEllipsis:true } -->
171
171
``` csharp
172
172
class MasterFileFormatCorruptException : System .Exception { ... }
173
173
class MasterFileLockedOpenException : System .Exception { ... }
@@ -212,7 +212,7 @@ where
212
212
213
213
If the source code contained a declaration like:
214
214
215
- <!-- IncludeFileNeededExample : {template:"standalone-lib", name:"TagInclude ", replaceEllipsis:true} -->
215
+ <!-- Example : {template:"standalone-lib-without-using ", name:"TagInclude1 ", replaceEllipsis:true} -->
216
216
``` csharp
217
217
/// <include file =" docs.xml" path =' extradoc/class[@name="IntList"]/*' />
218
218
public class IntList { ... }
@@ -238,7 +238,8 @@ and the external file “docs.xml” had the following contents:
238
238
239
239
then the same documentation is output as if the source code contained:
240
240
241
- ``` xml
241
+ <!-- Example: {template:"standalone-lib-without-using", name:"TagInclude2", replaceEllipsis:true} -->
242
+ ``` csharp
242
243
/// <summary >
243
244
/// Contains a list of integers.
244
245
/// </summary >
@@ -278,7 +279,7 @@ where
278
279
279
280
** Example:**
280
281
281
- <!-- Example: {template:"standalone-lib", name:"TagList", replaceEllipsis:true, ignoredWarnings:["CS1591"]} -->
282
+ <!-- Example: {template:"standalone-lib-without-using ", name:"TagList", replaceEllipsis:true, ignoredWarnings:["CS1591"]} -->
282
283
``` csharp
283
284
public class MyClass
284
285
{
@@ -313,7 +314,7 @@ where
313
314
314
315
** Example:**
315
316
316
- <!-- IncompleteExample : {template:"standalone-lib", name:"TagPara", replaceEllipsis:true, expectedErrors:["x","x"], expectedWarnings:["x","x"] } -->
317
+ <!-- Example : {template:"standalone-lib-without-using ", name:"TagPara", replaceEllipsis:true} -->
317
318
``` csharp
318
319
public class Point
319
320
{
@@ -346,7 +347,7 @@ where
346
347
347
348
** Example:**
348
349
349
- <!-- IncompleteExample : {template:"standalone-lib", name:"TagParam", ignoredWarnings:["CS1591"]} -->
350
+ <!-- Example : {template:"standalone-lib-without-using ", name:"TagParam", replaceEllipsis:true , ignoredWarnings:["CS1591"]} -->
350
351
``` csharp
351
352
public class Point
352
353
{
@@ -377,7 +378,7 @@ where
377
378
378
379
** Example:**
379
380
380
- <!-- IncompleteExample : {template:"standalone-lib", name:"TagParamref", ignoredWarnings:["CS1591"]} -->
381
+ <!-- Example : {template:"standalone-lib-without-using ", name:"TagParamref", replaceEllipsis:true , ignoredWarnings:["CS1591"]} -->
381
382
``` csharp
382
383
public class Point
383
384
{
@@ -408,7 +409,7 @@ where
408
409
409
410
** Example:**
410
411
411
- <!-- IncompleteExample : {template:"standalone-lib", name:"TagPermission", replaceEllipsis:true, ignoredWarnings:["CS1591"]} -->
412
+ <!-- Example : {template:"standalone-lib-without-using ", name:"TagPermission", replaceEllipsis:true, ignoredWarnings:["CS1591"]} -->
412
413
``` csharp
413
414
public class MyClass
414
415
{
@@ -436,7 +437,7 @@ where
436
437
437
438
** Example:**
438
439
439
- <!-- Example: {template:"standalone-lib", name:"TagRemarks", replaceEllipsis:true} -->
440
+ <!-- Example: {template:"standalone-lib-without-using ", name:"TagRemarks", replaceEllipsis:true} -->
440
441
``` csharp
441
442
/// <summary >
442
443
/// Class <c >Point</c > models a point in a two-dimensional plane.
@@ -464,7 +465,7 @@ where
464
465
465
466
** Example:**
466
467
467
- <!-- IncompleteExample : {template:"standalone-lib", name:"TagReturns", replaceEllipsis:true, expectedErrors:["x","x"], expectedWarnings:["x","x"] } -->
468
+ <!-- Example : {template:"standalone-lib-without-using ", name:"TagReturns", replaceEllipsis:true} -->
468
469
``` csharp
469
470
public class Point
470
471
{
@@ -476,6 +477,8 @@ public class Point
476
477
/// without any leading, trailing, or embedded whitespace.
477
478
/// </returns >
478
479
public override string ToString () => $" ({X },{Y })" ;
480
+ public int X { get ; set ; }
481
+ public int Y { get ; set ; }
479
482
}
480
483
```
481
484
@@ -495,7 +498,7 @@ where
495
498
496
499
** Example:**
497
500
498
- <!-- IncompleteExample : {template:"standalone-lib", name:"TagSee", replaceEllipsis:true, ignoredWarnings:["CS1591"]} -->
501
+ <!-- Example : {template:"standalone-lib-without-using ", name:"TagSee", replaceEllipsis:true, ignoredWarnings:["CS1591"]} -->
499
502
``` csharp
500
503
public class Point
501
504
{
@@ -532,7 +535,7 @@ where
532
535
533
536
** Example:**
534
537
535
- <!-- IncompleteExample : {template:"standalone-lib", name:"TagSeealso", replaceEllipsis:true, expectedErrors:["CS0161"], expectedWarnings:["CS0659"]} -->
538
+ <!-- Example : {template:"standalone-lib-without-using ", name:"TagSeealso", replaceEllipsis:true, expectedErrors:["CS0161"], expectedWarnings:["CS0659"]} -->
536
539
``` csharp
537
540
public class Point
538
541
{
@@ -562,7 +565,7 @@ where
562
565
563
566
** Example:**
564
567
565
- <!-- IncompleteExample : {template:"standalone-lib", name:"TagSummary", replaceEllipsis:true, ignoredWarnings:["CS1591"]} -->
568
+ <!-- Example : {template:"standalone-lib-without-using ", name:"TagSummary", replaceEllipsis:true, ignoredWarnings:["CS1591"]} -->
566
569
``` csharp
567
570
public class Point
568
571
{
@@ -598,7 +601,7 @@ where
598
601
599
602
** Example:**
600
603
601
- <!-- Example: {template:"standalone-lib", name:"TagTypeparam", replaceEllipsis:true} -->
604
+ <!-- Example: {template:"standalone-lib-without-using ", name:"TagTypeparam", replaceEllipsis:true} -->
602
605
``` csharp
603
606
/// <summary >A generic list class.</summary >
604
607
/// <typeparam name =" T" >The type stored by the list.</typeparam >
@@ -622,7 +625,7 @@ where
622
625
623
626
** Example:**
624
627
625
- <!-- IncompleteExample : {template:"standalone-lib", name:"TagTypeparamref", replaceEllipsis:true, expectedErrors:["CS0161"]} -->
628
+ <!-- Example : {template:"standalone-lib-without-using ", name:"TagTypeparamref", replaceEllipsis:true, expectedErrors:["CS0161"]} -->
626
629
``` csharp
627
630
public class MyClass
628
631
{
@@ -631,7 +634,7 @@ public class MyClass
631
634
/// <typeparamref name =" T" />.
632
635
/// </summary >
633
636
/// <param name =" string" >query to execute</param >
634
- public System.Collections.Generic. List <T > FetchData <T >(string query )
637
+ public List <T > FetchData <T >(string query )
635
638
{
636
639
.. .
637
640
}
@@ -652,18 +655,12 @@ where
652
655
653
656
** Example:**
654
657
655
- <!-- IncompleteExample : {template:"standalone-lib", name:"TagValue", ignoredWarnings:["CS1591"]} -->
658
+ <!-- Example : {template:"standalone-lib-without-using ", name:"TagValue", ignoredWarnings:["CS1591"]} -->
656
659
``` csharp
657
660
public class Point
658
661
{
659
- private int x ;
660
-
661
662
/// <value >Property <c >X</c > represents the point's x-coordinate.</value >
662
- public int X
663
- {
664
- get { return x ; }
665
- set { x = value ; }
666
- }
663
+ public int X { get ; set ; }
667
664
}
668
665
```
669
666
@@ -711,7 +708,7 @@ The following examples each show a fragment of C\# code, along with the ID stri
711
708
712
709
** Types** are represented using their fully qualified name, augmented with generic information:
713
710
714
- <!-- Example: {template:"standalone-lib", name:"IDStringsTypes", replaceEllipsis:true} -->
711
+ <!-- Example: {template:"standalone-lib-without-using ", name:"IDStringsTypes", replaceEllipsis:true} -->
715
712
``` csharp
716
713
enum Color { Red , Blue , Green }
717
714
753
750
754
751
** Fields** are represented by their fully qualified name.
755
752
756
- <!-- Example: {template:"standalone-lib", name:"IDStringsFields", ignoredWarnings:["CS0169","CS0649"], additionalFiles:["Acme.cs"]} -->
753
+ <!-- Example: {template:"standalone-lib-without-using ", name:"IDStringsFields", ignoredWarnings:["CS0169","CS0649"], additionalFiles:["Acme.cs"]} -->
757
754
``` csharp
758
755
namespace Acme
759
756
{
798
795
799
796
** Constructors**
800
797
801
- <!-- Example: {template:"standalone-lib", name:"IDStringsConstructors", replaceEllipsis:true, additionalFiles:["Acme.cs"]} -->
798
+ <!-- Example: {template:"standalone-lib-without-using ", name:"IDStringsConstructors", replaceEllipsis:true, additionalFiles:["Acme.cs"]} -->
802
799
``` csharp
803
800
namespace Acme
804
801
{
821
818
822
819
** Finalizers**
823
820
824
- <!-- Example: {template:"standalone-lib", name:"IDStringsFinalizers", replaceEllipsis:true, additionalFiles:["Acme.cs"]} -->
821
+ <!-- Example: {template:"standalone-lib-without-using ", name:"IDStringsFinalizers", replaceEllipsis:true, additionalFiles:["Acme.cs"]} -->
825
822
``` csharp
826
823
namespace Acme
827
824
{
840
837
841
838
** Methods**
842
839
843
- <!-- Example: {template:"standalone-lib", name:"IDStringsMethods", replaceEllipsis:true, customEllipsisReplacements:[null,null,null,"f = 0f;",null,null,null,null,null,null,null,"return null;"], ignoredWarnings:["CS0169","CS0649"], additionalFiles:["Acme.cs"]} -->
840
+ <!-- Example: {template:"standalone-lib-without-using ", name:"IDStringsMethods", replaceEllipsis:true, customEllipsisReplacements:[null,null,null,"f = 0f;",null,null,null,null,null,null,null,"return null;"], ignoredWarnings:["CS0169","CS0649"], additionalFiles:["Acme.cs"]} -->
844
841
``` csharp
845
842
namespace Acme
846
843
{
897
894
898
895
** Properties and indexers**
899
896
900
- <!-- IncompleteExample : {template:"standalone-lib", name:"IDStringsPropertiesAndIndexers", replaceEllipsis:true} -->
897
+ <!-- Example : {template:"standalone-lib-without-using ", name:"IDStringsPropertiesAndIndexers", replaceEllipsis:true, customEllipsisReplacements: ["return default;", "return;","return default;", "return;","return default;", "return;"], additionalFiles:["IProcess.cs"] } -->
901
898
``` csharp
902
899
namespace Acme
903
900
{
920
917
921
918
** Events**
922
919
923
- <!-- Example: {template:"standalone-lib", name:"IDStringsEvents", ignoredWarnings:["CS0067"], additionalFiles:["Acme.cs"]} -->
920
+ <!-- Example: {template:"standalone-lib-without-using ", name:"IDStringsEvents", ignoredWarnings:["CS0067"], additionalFiles:["Acme.cs"]} -->
924
921
``` csharp
925
922
namespace Acme
926
923
{
939
936
940
937
** Unary operators**
941
938
942
- <!-- IncompleteExample : {template:"standalone-lib", name:"IDStringsUnaryOps", replaceEllipsis:true} -->
939
+ <!-- Example : {template:"standalone-lib-without-using ", name:"IDStringsUnaryOps", replaceEllipsis:true, customEllipsisReplacements: ["return default;"], additionalFiles:["IProcess.cs"] } -->
943
940
``` csharp
944
941
namespace Acme
945
942
{
@@ -960,7 +957,7 @@ The complete set of unary operator function names used is as follows: `op_UnaryP
960
957
961
958
** Binary operators**
962
959
963
- <!-- IncompleteExample : {template:"standalone-lib", name:"IDStringsBinaryOps", replaceEllipsis:true} -->
960
+ <!-- Example : {template:"standalone-lib-without-using ", name:"IDStringsBinaryOps", replaceEllipsis:true, customEllipsisReplacements:["return default;"], additionalFiles:["IProcess.cs"] } -->
964
961
``` csharp
965
962
namespace Acme
966
963
{
@@ -981,7 +978,7 @@ The complete set of binary operator function names used is as follows: `op_Addit
981
978
982
979
** Conversion operators** have a trailing “` ~ ` ” followed by the return type.
983
980
984
- <!-- IncompleteExample : {template:"standalone-lib", name:"IDStringsConversionOps", replaceEllipsis:true} -->
981
+ <!-- Example : {template:"standalone-lib-without-using ", name:"IDStringsConversionOps", replaceEllipsis:true, customEllipsisReplacements:["return default;","return default;"], additionalFiles:["IProcess.cs"] } -->
985
982
``` csharp
986
983
namespace Acme
987
984
{
@@ -1006,7 +1003,7 @@ IDs:
1006
1003
1007
1004
The following example shows the source code of a Point class:
1008
1005
1009
- <!-- Example: {template:"standalone-lib", name:"WholePointClass", replaceEllipsis:true, ignoredWarnings:["CS0659","CS0661","CS0253"]} -->
1006
+ <!-- Example: {template:"standalone-lib-without-using ", name:"WholePointClass", replaceEllipsis:true, ignoredWarnings:["CS0659","CS0661","CS0253"]} -->
1010
1007
``` csharp
1011
1008
namespace Graphics
1012
1009
{
@@ -1015,33 +1012,15 @@ namespace Graphics
1015
1012
/// </summary >
1016
1013
public class Point
1017
1014
{
1018
- /// <summary >
1019
- /// Instance variable <c >x</c > represents the point's x-coordinate.
1020
- /// </summary >
1021
- private int x ;
1022
-
1023
- /// <summary >
1024
- /// Instance variable <c >y</c > represents the point's y-coordinate.
1025
- /// </summary >
1026
- private int y ;
1027
-
1028
1015
/// <value >
1029
1016
/// Property <c >X</c > represents the point's x-coordinate.
1030
1017
/// </value >
1031
- public int X
1032
- {
1033
- get { return x ; }
1034
- set { x = value ; }
1035
- }
1018
+ public int X { get ; set ; }
1036
1019
1037
1020
/// <value >
1038
1021
/// Property <c >Y</c > represents the point's y-coordinate.
1039
1022
/// </value >
1040
- public int Y
1041
- {
1042
- get { return y ; }
1043
- set { y = value ; }
1044
- }
1023
+ public int Y { get ; set ; }
1045
1024
1046
1025
/// <summary >
1047
1026
/// This constructor initializes the new Point to (0,0).
@@ -1195,16 +1174,6 @@ Here is the output produced by one documentation generator when given the source
1195
1174
<summary >Class <c >Point</c > models a point in a two-dimensional
1196
1175
plane.
1197
1176
</summary >
1198
- </member >
1199
- <member name =" F:Graphics.Point.x" >
1200
- <summary >
1201
- Instance variable <c >x</c > represents the point's x-coordinate.
1202
- </summary >
1203
- </member >
1204
- <member name =" F:Graphics.Point.y" >
1205
- <summary >
1206
- Instance variable <c >y</c > represents the point's y-coordinate.
1207
- </summary >
1208
1177
</member >
1209
1178
<member name =" M:Graphics.Point.#ctor" >
1210
1179
<summary >This constructor initializes the new Point to (0, 0).</summary >
0 commit comments