Skip to content

Restored enumeration member remarks #4 #1842

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.

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

Merged
merged 3 commits into from
Feb 14, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
41 changes: 13 additions & 28 deletions xml/System.Xml.Schema/XmlSchemaContentProcessing.xml
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,10 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>If the associated schema is found, the document items will be validated. No errors will be thrown otherwise.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
If the item is not validated, the XML processor attempts to notify the client through a validation event handler with <xref:System.Xml.Schema.ValidationEventArgs.Severity%2A> = `XmlSeverityType.Warning`. If a validation event handler has not been set up, no information is returned when the warning is produced.

]]></format>
</remarks>
<summary>If the associated schema is found, the document items will be validated. No errors will be thrown otherwise.

If the item is not validated, the XML processor attempts to notify the client through a validation event handler with <see cref="P:System.Xml.Schema.ValidationEventArgs.Severity" /> = <see langword="XmlSeverityType.Warning" />. If a validation event handler has not been set up, no information is returned when the warning is produced.
</summary>
</Docs>
</Member>
<Member MemberName="None">
Expand Down Expand Up @@ -146,15 +141,10 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Document items must consist of well-formed XML and are not validated by the schema.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The XML processor attempts to notify the client through a validation event handler with <xref:System.Xml.Schema.ValidationEventArgs.Severity%2A> = `XmlSeverityType.Warning` that no validation took place for the given item. If a validation event handler has not been set up, no information is returned when the warning is produced.

]]></format>
</remarks>
<summary>Document items must consist of well-formed XML and are not validated by the schema.

The XML processor attempts to notify the client through a validation event handler with <see cref="P:System.Xml.Schema.ValidationEventArgs.Severity" /> = <see langword="XmlSeverityType.Warning" /> that no validation took place for the given item. If a validation event handler has not been set up, no information is returned when the warning is produced.
</summary>
</Docs>
</Member>
<Member MemberName="Strict">
Expand Down Expand Up @@ -191,16 +181,11 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>The schema processor must find a schema associated with the indicated namespace to validate the document items.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
If the processor cannot find a schema, or the items are not valid, the XML processor attempts to notify the client through a validation event handler with <xref:System.Xml.Schema.ValidationEventArgs.Severity%2A> = `XmlSeverityType.Warning`. If a validation error occurs and a validation event handler is not provided, an exception is thrown.

]]></format>
</remarks>
</Docs>
<summary>The schema processor must find a schema associated with the indicated namespace to validate the document items.

If the processor cannot find a schema or if the items are not valid, the XML processor attempts to notify the client through a validation event handler with <see cref="P:System.Xml.Schema.ValidationEventArgs.Severity" /> = <see langword="XmlSeverityType.Warning" />. If a validation error occurs and a validation event handler is not provided, an exception is thrown.
</summary>
</Docs>
</Member>
</Members>
</Type>
35 changes: 10 additions & 25 deletions xml/System.Xml/ConformanceLevel.xml
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,13 @@
When you create an XML reader or writer instance, you can use the <xref:System.Xml.XmlReaderSettings> or <xref:System.Xml.XmlWriterSettings> class to specify the features that you want the new instance to support. One of the features that you can configure is the level of conformance you want to enforce on the XML data.

Creating a compliant reader or writer guarantees that the XML data being processed complies with the specified conformance level. If the stream being read or written doesn't comply with the conformance level, an exception is thrown.

Document-level checks with the `ConformanceLevel.Document` enumeration member enforce fragment-level checks (the `ConfomanceLevel.Fragment` member) and also ensure the following:

- The top-level item doesn't have any nodes other than the XML declaration, DTD, element, comment, white space, or processing instruction.

- The XML data has one and only one top-level element node.


]]></format>
</remarks>
Expand Down Expand Up @@ -111,21 +118,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>The XML data complies with the rules for a well-formed <see href="https://www.w3.org/TR/2006/REC-xml-20060816/#sec-well-formed">XML 1.0 document</see>, as defined by the W3C.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
This level of checking ensures that the stream being read or written can be consumed by any processor as an [XML 1.0 document](https://www.w3.org/TR/2006/REC-xml-20060816/#sec-well-formed).

Document-level checks enforce fragment-level checks and also ensure the following:

- The top-level item doesn't have any nodes other than the XML declaration, DTD, element, comment, white space, or processing instruction.

- The XML data has one and only one top-level element node.

]]></format>
</remarks>
<summary>The XML data complies with the rules for a well-formed <see href="https://www.w3.org/TR/2006/REC-xml-20060816/#sec-well-formed">XML 1.0 document</see>, as defined by the W3C. This level of checking ensures that the stream being read or written can be consumed by any processor as an <see href="https://www.w3.org/TR/2006/REC-xml-20060816/#sec-well-formed">XML 1.0 document</see>. </summary>
</Docs>
</Member>
<Member MemberName="Fragment">
Expand Down Expand Up @@ -159,16 +152,8 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>The XML data is a <see href="https://www.w3.org/TR/2006/REC-xml-20060816/#wf-entities">well-formed XML fragment</see>, as defined by the W3C.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
This conformance level represents an XML document that might not have a root element but is otherwise well-formed. This level of checking ensures that the stream being read or written can be consumed by any processor as an [XML 1.0 external parsed entity](https://www.w3.org/TR/2006/REC-xml-20060816/#wf-entities).

]]></format>
</remarks>
<summary>The XML data is a <see href="https://www.w3.org/TR/2006/REC-xml-20060816/#wf-entities">well-formed XML fragment</see>, as defined by the W3C. This conformance level represents an XML document that might not have a root element but is otherwise well-formed. This level of checking ensures that the stream being read or written can be consumed by any processor as an <see href="https://www.w3.org/TR/2006/REC-xml-20060816/#wf-entities">XML 1.0 external parsed entity]</see>.</summary>
</Docs>
</Member>
</Members>
</Type>
</Type>
16 changes: 3 additions & 13 deletions xml/System.Xml/DtdProcessing.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
This enumeration is set on the <xref:System.Xml.XmlReaderSettings.DtdProcessing%2A> property or the <xref:System.Xml.XmlTextReader.DtdProcessing%2A> property.
This enumeration is set on the <xref:System.Xml.XmlReaderSettings.DtdProcessing%2A?displayProperty=nameWithType> property or the <xref:System.Xml.XmlTextReader.DtdProcessing%2A?displayProperty=nameWithType> property.

]]></format>
</remarks>
Expand Down Expand Up @@ -67,17 +67,7 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Causes the DOCTYPE element to be ignored. No DTD processing occurs.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

> [!IMPORTANT]
> The DTD/DOCTYPE will be lost on output.

]]></format>
</remarks>
<summary>Causes the DOCTYPE element to be ignored. No DTD processing occurs, and the DTD/DOCTYPE is lost on output.</summary>
</Docs>
</Member>
<Member MemberName="Parse">
Expand Down Expand Up @@ -144,4 +134,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>
28 changes: 9 additions & 19 deletions xml/System.Xml/EntityHandling.xml
Original file line number Diff line number Diff line change
Expand Up @@ -59,17 +59,12 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>Expands character entities and returns general entities as <see cref="F:System.Xml.XmlNodeType.EntityReference" /> nodes.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
<summary>Expands character entities and returns general entities as <see cref="F:System.Xml.XmlNodeType.EntityReference" /> nodes.

You must call <see cref="Overload:System.Xml.XmlReader.ResolveEntity" /> to see what the general entities expand to. This enables you to optimize entity handling by only expanding the entity the first time it is used.

## Remarks
You must call <xref:System.Xml.XmlReader.ResolveEntity%2A> to see what the general entities expand to. This enables you to optimize entity handling by only expanding the entity the first time it is used.

When set to ExpandCharEntities, a reader call to the <xref:System.Xml.XmlReader.GetAttribute%2A> method expands all entities (both general and character entities).

]]></format>
</remarks>
When set to <see langword="ExpandCharEntities" />, a reader call to the <see cref="Overload:System.Xml.XmlReader.GetAttribute" /> method expands all entities (both general and character entities).
</summary>
</Docs>
</Member>
<Member MemberName="ExpandEntities">
Expand Down Expand Up @@ -101,15 +96,10 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Expands all entities and returns the expanded nodes.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
<xref:System.Xml.XmlNodeType.EntityReference> nodes are not returned. The entity text is expanded in place of the entity references.

]]></format>
</remarks>
<summary>Expands all entities and returns the expanded nodes.

<see cref="T:System.Xml.XmlNodeType.EntityReference" /> nodes are not returned. The entity text is expanded in place of the entity references.
</summary>
</Docs>
</Member>
</Members>
Expand Down
16 changes: 6 additions & 10 deletions xml/System.Xml/Formatting.xml
Original file line number Diff line number Diff line change
Expand Up @@ -58,15 +58,11 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Causes child elements to be indented according to the <see cref="P:System.Xml.XmlTextWriter.Indentation" /> and <see cref="P:System.Xml.XmlTextWriter.IndentChar" /> settings.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
This option indents element content only; mixed content is not affected. For the XML 1.0 definitions of these terms, see the World Wide Web Consortium (W3C) documentation (www.w3.org/TR/1998/REC-xml-19980210#sec-element-content and www.w3.org/TR/1998/REC-xml-19980210#sec-mixed-content).

]]></format>
</remarks>
<summary>Causes child elements to be indented according to the <see cref="P:System.Xml.XmlTextWriter.Indentation" /> and <see cref="P:System.Xml.XmlTextWriter.IndentChar" /> settings.

This option indents element content only; mixed content is not affected. For the XML 1.0 definitions of these terms, see the World Wide Web Consortium (W3C) documentation <see href="https://www.w3.org/TR/1998/REC-xml-19980210#sec-element-content">Element Content</see> and <see href="https://www.w3.org/TR/1998/REC-xml-19980210#sec-mixed-content">Mixed Content</see>.

</summary>
</Docs>
</Member>
<Member MemberName="None">
Expand Down Expand Up @@ -102,4 +98,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>
47 changes: 13 additions & 34 deletions xml/System.Xml/ValidationType.xml
Original file line number Diff line number Diff line change
Expand Up @@ -73,17 +73,10 @@
</ReturnValue>
<MemberValue>1</MemberValue>
<Docs>
<summary>Validates if DTD or schema information is found.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

> [!NOTE]
> This field is obsolete in the Microsoft .NET Framework version 2.0 and is applicable only to the <xref:System.Xml.XmlValidatingReader> class.

]]></format>
</remarks>
<summary>Validates if DTD or schema information is found.

Starting with .NET Framework 2.0, this field is obsolete. It applies only to the obsolete <see cref="T:System.Xml.XmlValidatingReader" /> class.
</summary>
</Docs>
</Member>
<Member MemberName="DTD">
Expand Down Expand Up @@ -147,17 +140,10 @@
</ReturnValue>
<MemberValue>0</MemberValue>
<Docs>
<summary>No validation is performed. This setting creates an XML 1.0 compliant non-validating parser.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
Default attributes are reported and general entities can be resolved by calling <xref:System.Xml.XmlReader.ResolveEntity%2A>. The DOCTYPE is not used for validation purposes.

No validation errors are thrown.

]]></format>
</remarks>
<summary>No validation is performed, and no validation errors are thrown. This setting creates an XML 1.0 compliant non-validating parser.

Calls to <see cref="M:System.Xml.XmlReader.ResolveEntity" /> report default attributes and resolve general enttities. The DOCTYPE is not used for validation purposes.
</summary>
</Docs>
</Member>
<Member MemberName="Schema">
Expand Down Expand Up @@ -226,18 +212,11 @@
</ReturnValue>
<MemberValue>3</MemberValue>
<Docs>
<summary>Validate according to XML-Data Reduced (XDR) schemas, including inline XDR schemas. XDR schemas are recognized using the <see langword="x-schema" /> namespace prefix or the <see cref="P:System.Xml.XmlValidatingReader.Schemas" /> property.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

> [!NOTE]
> This field is obsolete in the Microsoft .NET Framework version 2.0 and is applicable only to the <xref:System.Xml.XmlValidatingReader> class.

]]></format>
</remarks>
<summary>Validate according to XML-Data Reduced (XDR) schemas, including inline XDR schemas. XDR schemas are recognized using the <see langword="x-schema" /> namespace prefix or the <see cref="P:System.Xml.XmlValidatingReader.Schemas" /> property.

Starting with .NET Framework 2.0, this field is obsolete. It applies only to the obsolete <see cref="T:System.Xml.XmlValidatingReader" /> class.
</summary>
</Docs>
</Member>
</Members>
</Type>
</Type>
15 changes: 4 additions & 11 deletions xml/System.Xml/WriteState.xml
Original file line number Diff line number Diff line change
Expand Up @@ -203,17 +203,10 @@
</ReturnValue>
<MemberValue>6</MemberValue>
<Docs>
<summary>An exception has been thrown, which has left the <see cref="T:System.Xml.XmlWriter" /> in an invalid state. You can call the <see cref="M:System.Xml.XmlWriter.Close" /> method to put the <see cref="T:System.Xml.XmlWriter" /> in the <see cref="F:System.Xml.WriteState.Closed" /> state. Any other <see cref="T:System.Xml.XmlWriter" /> method calls results in an <see cref="T:System.InvalidOperationException" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

> [!NOTE]
> This field was added in the [!INCLUDE[dnprdnext](~/includes/dnprdnext-md.md)] release.

]]></format>
</remarks>
<summary>An exception has been thrown, which has left the <see cref="T:System.Xml.XmlWriter" /> in an invalid state. You can call the <see cref="M:System.Xml.XmlWriter.Close" /> method to put the <see cref="T:System.Xml.XmlWriter" /> in the <see cref="F:System.Xml.WriteState.Closed" /> state. Any other <see cref="T:System.Xml.XmlWriter" /> method calls results in an <see cref="T:System.InvalidOperationException" />.

This field was added in .NET Framework 2.0.
</summary>
</Docs>
</Member>
<Member MemberName="Prolog">
Expand Down
12 changes: 2 additions & 10 deletions xml/System.Xml/XmlDateTimeSerializationMode.xml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
This enumeration is used by the <xref:System.Xml.XmlConvert.ToDateTime%2A> and <xref:System.Xml.XmlConvert.ToString%2A> methods.
This enumeration is used by the <xref:System.Xml.XmlConvert.ToDateTime%2A?displayProperty=nameWithType> and <xref:System.Xml.XmlConvert.ToString%2A?displayProperty=nameWithType> methods.

]]></format>
</remarks>
Expand Down Expand Up @@ -133,15 +133,7 @@
</ReturnValue>
<MemberValue>2</MemberValue>
<Docs>
<summary>Treat as a local time if a <see cref="T:System.DateTime" /> is being converted to a string.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
If a string is being converted to <xref:System.DateTime>, convert to a local time if a time zone is specified.

]]></format>
</remarks>
<summary>Treat as a local time if a <see cref="T:System.DateTime" /> is being converted to a string. If a string is being converted to <see cref="T:System.DateTime" />, convert to a local time if a time zone is specified. </summary>
</Docs>
</Member>
<Member MemberName="Utc">
Expand Down
Loading