Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Automatic port of RegexParse* documentation #4850

Merged
merged 6 commits into from
Sep 16, 2020
Merged

Automatic port of RegexParse* documentation #4850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c7eab1f
Automatic port of RegexParse* documentation
carlossanlop Sep 15, 2020
966a464
Update xml/System.Text.RegularExpressions/RegexParseError.xml
carlossanlop Sep 15, 2020
b5e83bc
Apply suggestions from code review
carlossanlop Sep 15, 2020
e71cd07
Update RegexParseException
Sep 15, 2020
6bd16d4
Update xml/System.Text.RegularExpressions/RegexParseException.xml
carlossanlop Sep 15, 2020
b628d8b
Update xml/System.Text.RegularExpressions/RegexParseException.xml
carlossanlop Sep 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
76 changes: 42 additions & 34 deletions xml/System.Text.RegularExpressions/RegexParseError.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,16 @@
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<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>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

This information is made available through <xref:System.Text.RegularExpressions.RegexParseException.Error>.

]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName="AlternationHasComment">
Expand All @@ -34,7 +42,7 @@
</ReturnValue>
<MemberValue>17</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>An alternation construct in a regular expression contains a comment.</summary>
</Docs>
</Member>
<Member MemberName="AlternationHasMalformedCondition">
Expand All @@ -54,7 +62,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>An alternation in a regular expression has a malformed condition.</summary>
</Docs>
</Member>
<Member MemberName="AlternationHasMalformedReference">
Expand All @@ -74,7 +82,7 @@
</ReturnValue>
<MemberValue>18</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>An alternation construct in a regular expression contains a malformed reference.</summary>
</Docs>
</Member>
<Member MemberName="AlternationHasNamedCapture">
Expand All @@ -94,7 +102,7 @@
</ReturnValue>
<MemberValue>16</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>An alternation construct in a regular expression uses a named capture.</summary>
</Docs>
</Member>
<Member MemberName="AlternationHasTooManyConditions">
Expand All @@ -114,7 +122,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>An alternation in a regular expression has too many conditions.</summary>
</Docs>
</Member>
<Member MemberName="AlternationHasUndefinedReference">
Expand All @@ -134,7 +142,7 @@
</ReturnValue>
<MemberValue>19</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>An alternation construct in a regular expression contains an undefined reference.</summary>
</Docs>
</Member>
<Member MemberName="CaptureGroupNameInvalid">
Expand All @@ -154,7 +162,7 @@
</ReturnValue>
<MemberValue>20</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>The group name of a captured group in a regular expression is invalid.</summary>
</Docs>
</Member>
<Member MemberName="CaptureGroupOfZero">
Expand All @@ -174,7 +182,7 @@
</ReturnValue>
<MemberValue>21</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A regular expression defines a numbered subexpression named zero.</summary>
</Docs>
</Member>
<Member MemberName="ExclusionGroupNotLast">
Expand All @@ -194,7 +202,7 @@
</ReturnValue>
<MemberValue>23</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A character class in a regular expression with an exclusion group is not the last part of the character class.</summary>
</Docs>
</Member>
<Member MemberName="InsufficientClosingParentheses">
Expand All @@ -214,7 +222,7 @@
</ReturnValue>
<MemberValue>26</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A regular expression has a non-escaped left parenthesis, or misses a closing right parenthesis.</summary>
</Docs>
</Member>
<Member MemberName="InsufficientOpeningParentheses">
Expand All @@ -234,7 +242,7 @@
</ReturnValue>
<MemberValue>30</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A regular expression has a non-escaped right parenthesis, or misses an opening left parenthesis.</summary>
</Docs>
</Member>
<Member MemberName="InsufficientOrInvalidHexDigits">
Expand All @@ -254,7 +262,7 @@
</ReturnValue>
<MemberValue>8</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A hexadecimal escape sequence in a regular expression does not have enough digits, or contains invalid digits.</summary>
</Docs>
</Member>
<Member MemberName="InvalidGroupingConstruct">
Expand All @@ -274,7 +282,7 @@
</ReturnValue>
<MemberValue>15</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A grouping construct in a regular expression is invalid or malformed.</summary>
</Docs>
</Member>
<Member MemberName="InvalidUnicodePropertyEscape">
Expand All @@ -294,7 +302,7 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A Unicode property escape in a regular expression is invalid or unknown.</summary>
</Docs>
</Member>
<Member MemberName="MalformedNamedReference">
Expand All @@ -314,7 +322,7 @@
</ReturnValue>
<MemberValue>12</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A named reference in a regular expression is malformed.</summary>
</Docs>
</Member>
<Member MemberName="MalformedUnicodePropertyEscape">
Expand All @@ -334,7 +342,7 @@
</ReturnValue>
<MemberValue>4</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A Unicode property escape is malformed.</summary>
</Docs>
</Member>
<Member MemberName="MissingControlCharacter">
Expand All @@ -354,7 +362,7 @@
</ReturnValue>
<MemberValue>7</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A control character in a regular expression is missing.</summary>
</Docs>
</Member>
<Member MemberName="NestedQuantifiersNotParenthesized">
Expand All @@ -374,7 +382,7 @@
</ReturnValue>
<MemberValue>28</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>Repeated quantifiers on another quantifier inside a regular expression are not grouped in parentheses.</summary>
</Docs>
</Member>
<Member MemberName="QuantifierAfterNothing">
Expand All @@ -394,7 +402,7 @@
</ReturnValue>
<MemberValue>29</MemberValue>
<Docs>
<summary>To be added.</summary>
<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>
</Docs>
</Member>
<Member MemberName="QuantifierOrCaptureGroupOutOfRange">
Expand All @@ -414,7 +422,7 @@
</ReturnValue>
<MemberValue>9</MemberValue>
<Docs>
<summary>To be added.</summary>
<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>
</Docs>
</Member>
<Member MemberName="ReversedCharacterRange">
Expand All @@ -434,7 +442,7 @@
</ReturnValue>
<MemberValue>24</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A character class in a regular expression contains an inverse character range, like z-a instead of a-z.</summary>
</Docs>
</Member>
<Member MemberName="ReversedQuantifierRange">
Expand All @@ -454,7 +462,7 @@
</ReturnValue>
<MemberValue>27</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A quantifier range in a regular expression is inverse, like <code>{10,1}</code> instead of <code>(1,10}</code>.</summary>
</Docs>
</Member>
<Member MemberName="ShorthandClassInCharacterRange">
Expand All @@ -474,7 +482,7 @@
</ReturnValue>
<MemberValue>25</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A character-class in a regular expression contains a short-hand class that is not allowed inside a character class.</summary>
</Docs>
</Member>
<Member MemberName="UndefinedNamedReference">
Expand All @@ -494,7 +502,7 @@
</ReturnValue>
<MemberValue>10</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A used named reference in a regular expression is not defined.</summary>
</Docs>
</Member>
<Member MemberName="UndefinedNumberedReference">
Expand All @@ -514,7 +522,7 @@
</ReturnValue>
<MemberValue>11</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A used numbered reference in a regular expression is not defined.</summary>
</Docs>
</Member>
<Member MemberName="UnescapedEndingBackslash">
Expand All @@ -534,7 +542,7 @@
</ReturnValue>
<MemberValue>13</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A regular expression ends with a non-escaped ending backslash.</summary>
</Docs>
</Member>
<Member MemberName="Unknown">
Expand All @@ -554,7 +562,7 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>An unknown regular expression parse error.</summary>
</Docs>
</Member>
<Member MemberName="UnrecognizedControlCharacter">
Expand All @@ -574,7 +582,7 @@
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A control character in a regular expression is not recognized.</summary>
</Docs>
</Member>
<Member MemberName="UnrecognizedEscape">
Expand All @@ -594,7 +602,7 @@
</ReturnValue>
<MemberValue>5</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>An escape character or sequence in a regular expression is invalid.</summary>
</Docs>
</Member>
<Member MemberName="UnrecognizedUnicodeProperty">
Expand All @@ -614,7 +622,7 @@
</ReturnValue>
<MemberValue>31</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A unicode property in a regular expression is not recognized, or invalid.</summary>
</Docs>
</Member>
<Member MemberName="UnterminatedBracket">
Expand All @@ -634,7 +642,7 @@
</ReturnValue>
<MemberValue>22</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A regular expression has a non-escaped left square bracket, or misses a closing right square bracket.</summary>
</Docs>
</Member>
<Member MemberName="UnterminatedComment">
Expand All @@ -654,7 +662,7 @@
</ReturnValue>
<MemberValue>14</MemberValue>
<Docs>
<summary>To be added.</summary>
<summary>A comment in a regular expression is not terminated.</summary>
</Docs>
</Member>
</Members>
Expand Down
21 changes: 10 additions & 11 deletions xml/System.Text.RegularExpressions/RegexParseException.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
</Base>
<Interfaces />
<Docs>
<summary>To be added.</summary>
<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>
<remarks>To be added.</remarks>
</Docs>
<Members>
Expand All @@ -34,9 +34,8 @@
<ReturnType>System.Text.RegularExpressions.RegexParseError</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the error that happened during parsing.</summary>
<value>The error that occured during parsing.</value>
</Docs>
</Member>
<Member MemberName="GetObjectData">
Expand All @@ -59,10 +58,11 @@
<Parameter Name="context" Type="System.Runtime.Serialization.StreamingContext" />
</Parameters>
<Docs>
<param name="info">To be added.</param>
<param name="context">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="info">The object that holds the serialized object data.</param>
<param name="context">The contextual information about the source or destination.</param>
<summary>Sets the <paramref name="info" /> object with the parameter name and additional exception information.</summary>
carlossanlop marked this conversation as resolved.
Show resolved Hide resolved
<exception cref="T:System.ArgumentNullException">
<paramref name="info" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="Offset">
Expand All @@ -81,9 +81,8 @@
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<summary>Gets the zero-based character offset in the regular expression pattern where the parse error occurs.</summary>
<value>The offset at which the parse error occurs.</value>
</Docs>
</Member>
</Members>
Expand Down