8000 Automatic port of RegexParse* documentation (#4850) · gewarren/dotnet-api-docs@489aec6 · GitHub
[go: up one dir, main page]
Skip to content

Commit 489aec6

Browse files
carlossanlopPrashanth Govindarajan
authored and
gewarren
committed
Automatic port of RegexParse* documentation (dotnet#4850)
* Automatic port of RegexParse* documentation * Update xml/System.Text.RegularExpressions/RegexParseError.xml * Apply suggestions from code review * Update RegexParseException * Update xml/System.Text.RegularExpressions/RegexParseException.xml * Update xml/System.Text.RegularExpressions/RegexParseException.xml Co-authored-by: carlossanlop <carlossanlop@users.noreply.github.com> Co-authored-by: Prashanth Govindarajan <prgovi@microsoft.com>
1 parent 5825ea0 commit 489aec6

File tree

2 files changed

+52
-45
lines changed

2 files changed

+52
-45
lines changed

‎xml/System.Text.RegularExpressions/RegexParseError.xml

Lines changed: 42 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,16 @@
1313
<BaseTypeName>System.Enum</BaseTypeName>
1414
</Base>
1515
<Docs>
16-
<summary>To be added.</summary>
17-
<remarks>To be added.</remarks>
16+
<summary>Specifies the detailed underlying reason why a <see cref="T:System.Text.RegularExpressions.RegexParseException" /> is thrown when a regular expression contains a parsing error.</summary>
17+
<remarks>
18+
<format type="text/markdown"><![CDATA[
19+
20+
## Remarks
21+
22+
This information is made available through <xref:System.Text.RegularExpressions.RegexParseException.Error>.
23+
24+
]]></format>
25+
</remarks>
1826
</Docs>
1927
<Members>
2028
<Member MemberName="AlternationHasComment">
@@ -34,7 +42,7 @@
3442
</ReturnValue>
3543
<MemberValue>17</MemberValue>
3644
<Docs>
37-
<summary>To be added.</summary>
45+
<summary>An alternation construct in a regular expression contains a comment.</summary>
3846
</Docs>
3947
</Member>
4048
<Member MemberName="AlternationHasMalformedCondition">
@@ -54,7 +62,7 @@
5462
</ReturnValue< E7F5 /span>>
5563
<MemberValue>2</MemberValue>
5664
<Docs>
57-
<summary>To be added.</summary>
65+
<summary>An alternation in a regular expression has a malformed condition.</summary>
5866
</Docs>
5967
</Member>
6068
<Member MemberName="AlternationHasMalformedReference">
@@ -74,7 +82,7 @@
7482
</ReturnValue>
7583
<MemberValue>18</MemberValue>
7684
<Docs>
77-
<summary>To be added.</summary>
85+
<summary>An alternation construct in a regular expression contains a malformed reference.</summary>
7886
</Docs>
7987
</Member>
8088
<Member MemberName="AlternationHasNamedCapture">
@@ -94,7 +102,7 @@
94102
</ReturnValue>
95103
<MemberValue>16</MemberValue>
96104
<Docs>
97-
<summary>To be added.</summary>
105+
<summary>An alternation construct in a regular expression uses a named capture.</summary>
98106
</Docs>
99107
</Member>
100108
<Member MemberName="AlternationHasTooManyConditions">
@@ -114,7 +122,7 @@
114122
</ReturnValue>
115123
<MemberValue>1</MemberValue>
116124
<Docs>
117-
<summary>To be added.</summary>
125+
<summary>An alternation in a regular expression has too many conditions.</summary>
118126
</Docs>
119127
</Member>
120128
<Member MemberName="AlternationHasUndefinedReference">
@@ -134,7 +142,7 @@
134142
</ReturnValue>
135143
<MemberValue>19</MemberValue>
136144
<Docs>
137-
<summary>To be added.</summary>
145+
<summary>An alternation construct in a regular expression contains an undefined reference.</summary>
138146
</Docs>
139147
</Member>
140148
<Member MemberName="CaptureGroupNameInvalid">
@@ -154,7 +162,7 @@
154162
</ReturnValue>
155163
<MemberValue>20</MemberValue>
156164
<Docs>
157-
<summary>To be added.</summary>
165+
<summary>The group name of a captured group in a regular expression is invalid.</summary>
158166
</Docs>
159167
</Member>
160168
<Member MemberName="CaptureGroupOfZero">
@@ -174,7 +182,7 @@
174182
</ReturnValue>
175183
<MemberValue>21</MemberValue>
176184
<Docs>
177-
<summary>To be added.</summary>
185+
<summary>A regular expression defines a numbered subexpression named zero.</summary>
178186
</Docs>
179187
</Member>
180188
<Member MemberName="ExclusionGroupNotLast">
@@ -194,7 +202,7 @@
194202
</ReturnValue>
195203
<MemberValue>23</MemberValue>
196204
<Docs>
197-
<summary>To be added.</summary>
205+
<summary>A character class in a regular expression with an exclusion group is not the last part of the character class.</summary>
198206
</Docs>
199207
</Member>
200208
<Member MemberName="InsufficientClosingParentheses">
@@ -214,7 +222,7 @@
214222
</ReturnValue>
215223
<MemberValue>26</MemberValue>
216224
<Docs>
217-
<summary>To be added.</summary>
225+
<summary>A regular expression has a non-escaped left parenthesis, or misses a closing right parenthesis.</summary>
218226
</Docs>
219227
</Member>
220228
<Member MemberName="InsufficientOpeningParentheses">
@@ -234,7 +242,7 @@
234242
</ReturnValue>
235243
<MemberValue>30</MemberValue>
236244
<Docs>
237-
<summary>To be added.</summary>
245+
<summary>A regular expression has a non-escaped right parenthesis, or misses an opening left parenthesis.</summary>
238246
</Docs>
239247
</Member>
240248
<Member MemberName="InsufficientOrInvalidHexDigits">
@@ -254,7 +262,7 @@
254262
</ReturnValue>
255263
<MemberValue>8</MemberValue>
256264
<Docs>
257-
<summary>To be added.</summary>
265+
<summary>A hexadecimal escape sequence in a regular expression does not have enough digits, or contains invalid digits.</summary>
258266
</Docs>
259267
</Member>
260268
<Member MemberName="InvalidGroupingConstruct">
@@ -274,7 +282,7 @@
274282
</ReturnValue>
275283
<MemberValue>15</MemberValue>
276284
<Docs>
277-
<summary>To be added.</summary>
285+
<summary>A grouping construct in a regular expression is invalid or malformed.</summary>
278286
</Docs>
279287
</Member>
280288
<Member MemberName="InvalidUnicodePropertyEscape">
@@ -294,7 +302,7 @@
294302
</ReturnValue>
295303
<MemberValue>3</MemberValue>
296304
<Docs>
297-
<summary>To be added.</summary>
305+
<summary>A Unicode property escape in a regular expression is invalid or unknown.</summary>
298306
</Docs>
299307
</Member>
300308
<Member MemberName="MalformedNamedReference">
@@ -314,7 +322,7 @@
314322
</ReturnValue>
315323
<MemberValue>12</MemberValue>
316324
<Docs>
317-
<summary>To be added.</summary>
325+
<summary>A named reference in a regular expression is malformed.</summary>
318326
</Docs>
319327
</Member>
320328
<Member MemberName="MalformedUnicodePropertyEscape">
@@ -334,7 +342,7 @@
334342
</ReturnValue>
335343
<MemberValue>4</MemberValue>
336344
<Docs>
337-
<summary>To be added.</summary>
345+
<summary>A Unicode property escape is malformed.</summary>
338346
</Docs>
339347
</Member>
340348
<Member MemberName="MissingControlCharacter">
@@ -354,7 +362,7 @@
354362
</ReturnValue>
355363
<MemberValue>7</MemberValue>
356364
<Docs>
357-
<summary>To be added.</summary>
365+
<summary>A control character in a regular expression is missing.</summary>
358366
</Docs>
359367
</Member>
360368
<Member MemberName="NestedQuantifiersNotParenthesized">
@@ -374,7 +382,7 @@
374382
</ReturnValue>
375383
<MemberValue>28</MemberValue>
376384
<Docs>
377-
<summary>To be added.</summary>
385+
<summary>Repeated quantifiers on another quantifier inside a regular expression are not grouped in parentheses.</summary>
378386
</Docs>
379387
</Member>
380388
<Member MemberName="QuantifierAfterNothing">
@@ -394,7 +402,7 @@
394402
</ReturnValue>
395403
<MemberValue>29</MemberValue>
396404
<Docs>
397-
<summary>To be added.</summary>
405+
<summary>A quantifier in a regular expression is in a position where it cannot quantify anything, like at the beginning of a regular expression or in a group.</summary>
398406
</Docs>
399407
</Member>
400408
<Member MemberName="QuantifierOrCaptureGroupOutOfRange">
@@ -414,7 +422,7 @@
414422
</ReturnValue>
415423
<MemberValue>9</MemberValue>
416424
<Docs>
417-
<summary>To be added.</summary>
425+
<summary>A captured group or a quantifier in a regular expression is not within range, that is, it is larger than <see cref="F:System.Int32.MaxValue" />.</summary>
418426
</Docs>
419427
</Member>
420428
<Member MemberName="ReversedCharacterRange">
@@ -434,7 +442,7 @@
434442
</ReturnValue>
435443
<MemberValue>24</MemberValue>
436444
<Docs>
437-
<summary>To be added.</summary>
445+
<summary>A character class in a regular expression contains an inverse character range, like z-a instead of a-z.</summary>
438446
</Docs>
439447
</Member>
440448
<Member MemberName="ReversedQuantifierRange">
@@ -454,7 +462,7 @@
454462
</ReturnValue>
455463
<MemberValue>27</MemberValue>
456464
<Docs>
457-
<summary>To be added.</summary>
465+
<summary>A quantifier range in a regular expression is inverse, like <code>{10,1}</code> instead of <code>(1,10}</code>.</summary>
458466
</Docs>
459467
</Member>
460468
<Member MemberName="ShorthandClassInCharacterRange">
@@ -474,7 +482,7 @@
474482
</ReturnValue>
475483
<MemberValue>25</MemberValue>
476484
<Docs>
477-
<summary>To be added.</summary>
485+
<summary>A character-class in a regular expression contains a short-hand class that is not allowed inside a character class.</summary>
478486
</Docs>
479487
</Member>
480488
<Member MemberName="UndefinedNamedReference">
@@ -494,7 +502,7 @@
494502
</ReturnValue>
495503
<MemberValue>10</MemberValue>
496504
<Docs>
497-
<summary>To be added.</summary>
505+
<summary>A used named reference in a regular expression is not defined.</summary>
498506
</Docs>
499507
</Member>
500508
<Member MemberName="UndefinedNumberedReference">
@@ -514,7 +522,7 @@
514522
</ReturnValue>
515523
<MemberValue>11</MemberValue>
516524
<Docs>
517-
<summary>To be added.</summary>
525+
<summary>A used numbered reference in a regular expression is not defined.</summary>
518526
</Docs>
519527
</Member>
520528
<Member MemberName="UnescapedEndingBackslash">
@@ -534,7 +542,7 @@
534542
</ReturnValue>
535543
<MemberValue>13</MemberValue>
536544
<Docs>
537-
<summary>To be added.</summary>
545+
<summary>A regular expression ends with a non-escaped ending backslash.</summary>
538546
</Docs>
539547
</Member>
540548
<Member MemberName="Unknown">
@@ -554,7 +562,7 @@
554562
</ReturnValue>
555563
<MemberValue>0</MemberValue>
556564
<Docs>
557-
<summary>To be added.</summary>
565+
<summary>An unknown regular expression parse error.</summary>
558566
</Docs>
559567
</Member>
560568
<Member MemberName="UnrecognizedControlCharacter">
@@ -574,7 +582,7 @@
574582
</ReturnValue>
575583
<MemberValue>6</MemberValue>
576584
<Docs>
577-
<summary>To be added.</summary>
585+
<summary>A control character in a regular expression is not recognized.</summary>
578586
</Docs>
579587
</Member>
580588
<Member MemberName="UnrecognizedEscape">
@@ -594,7 +602,7 @@
594602
</ReturnValue>
595603
<MemberValue>5</MemberValue>
596604
<Docs>
597-
<summary>To be added.</summary>
605+
<summary>An escape character or sequence in a regular expression is invalid.</summary>
598606
</Docs>
599607
</Member>
600608
<Member MemberName="UnrecognizedUnicodeProperty">
@@ -614,7 +622,7 @@
614622
</ReturnValue>
615623
<MemberValue>31</MemberValue>
616624
<Docs>
617-
<summary>To be added.</summary>
625+
<summary>A unicode property in a regular expression is not recognized, or invalid.</summary>
618626
</Docs>
619627
</Member>
620628
<Member MemberName="UnterminatedBracket">
@@ -634,7 +642,7 @@
634642
</ReturnValue>
635643
<MemberValue>22</MemberValue>
636644
<Docs>
637-
<summary>To be added.</summary>
645+
<summary>A regular expression has a non-escaped left square bracket, or misses a closing right square bracket.</summary>
638646
</Docs>
639647
</Member>
640648
<Member MemberName="UnterminatedComment">
@@ -654,7 +662,7 @@
654662
</ReturnValue>
655663
<MemberValue>14</MemberValue>
656664
<Docs>
657-
<summary>To be added.</summary>
665+
<summary>A comment in a regular expression is not terminated.</summary>
658666
</Docs>
659667
</Member>
660668
</Members>

‎xml/System.Text.RegularExpressions/RegexParseException.xml

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
</Base>
1515
<Interfaces />
1616
<Docs>
17-
<summary>To be added.</summary>
17+
<summary>An exception as a result of a parse error in a regular expression, with detailed information in the <see cref="P:System.Text.RegularExpressions.RegexParseException.Error" /> and <see cref="P:System.Text.RegularExpressions.RegexParseException.Offset" /> properties.</summary>
1818
<remarks>To be added.</remarks>
1919
</Docs>
2020
<Members>
@@ -34,9 +34,8 @@
3434
<ReturnType>System.Text.RegularExpressions.RegexParseError</ReturnType>
3535
</ReturnValue>
3636
<Docs>
37-
<summary>To be added.</summary>
38-
<value>To be added.</value>
39-
<remarks>To be added.</remarks>
37+
<summary>Gets the error that happened during parsing.</summary>
38+
<value>The error that occured during parsing.</value>
4039
</Docs>
4140
</Member>
4241
<Member MemberName="GetObjectData">
@@ -59,10 +58,11 @@
5958
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
6059
</Parameters>
6160
<Docs>
62-
<param name="info">To be added.</param>
63-
<param name="context">To be added.</param>
64-
<summary>To be added.</summary>
65-
<remarks>To be added.</remarks>
61+
<param name="info">The object that holds the serialized object data.</param>
62+
<param name="context">The contextual information about the source or destination.</param>
63+
<summary>Sets the <paramref name="info" /> object with the parameter name and additional exception information.</summary>
64+
<exception cref="T:System.ArgumentNullException">
65+
<paramref name="info" /> is <see langword="null" />.</exception>
6666
</Docs>
6767
</Member>
6868
<Member MemberName="Offset">
@@ -81,9 +81,8 @@
8181
<ReturnType>System.Int32</ReturnType>
8282
</ReturnValue>
8383
<Docs>
84-
<summary>To be added.</summary>
85-
<value>To be added.</value>
86-
<remarks>To be added.</remarks>
84+
<summary>Gets the zero-based character offset in the regular expression pattern where the parse error occurs.</summary>
85+
<value>The offset at which the parse error occurs.</value>
8786
</Docs>
8887
</Member>
8988
</Members>

0 commit comments

Comments
 (0)
0