From 9a918c53538167bdd0de60abf7bcb1e5c2db4bfe Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Tue, 12 Feb 2019 17:18:07 -0800 Subject: [PATCH 1/3] Added member remarks --- .../XmlSchemaContentProcessing.xml | 41 ++---- xml/System.Xml/ConformanceLevel.xml | 33 ++--- xml/System.Xml/DtdProcessing.xml | 14 +- xml/System.Xml/EntityHandling.xml | 28 ++-- xml/System.Xml/Formatting.xml | 14 +- xml/System.Xml/ValidationType.xml | 45 ++---- xml/System.Xml/WriteState.xml | 15 +- .../XmlDateTimeSerializationMode.xml | 12 +- xml/System.Xml/XmlNodeType.xml | 129 +++++------------- 9 files changed, 87 insertions(+), 244 deletions(-) diff --git a/xml/System.Xml.Schema/XmlSchemaContentProcessing.xml b/xml/System.Xml.Schema/XmlSchemaContentProcessing.xml index 417856b24d9..89f5ffe55f8 100644 --- a/xml/System.Xml.Schema/XmlSchemaContentProcessing.xml +++ b/xml/System.Xml.Schema/XmlSchemaContentProcessing.xml @@ -64,15 +64,10 @@ 2 - If the associated schema is found, the document items will be validated. No errors will be thrown otherwise. - - = `XmlSeverityType.Warning`. If a validation event handler has not been set up, no information is returned when the warning is produced. - - ]]> - + 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 = . If a validation event handler has not been set up, no information is returned when the warning is produced. + @@ -146,15 +141,10 @@ 1 - Document items must consist of well-formed XML and are not validated by the schema. - - = `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. - - ]]> - + 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 = 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. + @@ -191,16 +181,11 @@ 3 - The schema processor must find a schema associated with the indicated namespace to validate the document items. - - = `XmlSeverityType.Warning`. If a validation error occurs and a validation event handler is not provided, an exception is thrown. - - ]]> - - + 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 = . If a validation error occurs and a validation event handler is not provided, an exception is thrown. + + \ No newline at end of file diff --git a/xml/System.Xml/ConformanceLevel.xml b/xml/System.Xml/ConformanceLevel.xml index e4617118375..b31cdbf3144 100644 --- a/xml/System.Xml/ConformanceLevel.xml +++ b/xml/System.Xml/ConformanceLevel.xml @@ -35,6 +35,13 @@ When you create an XML reader or writer instance, you can use the or 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. + ]]> @@ -111,21 +118,7 @@ 2 - The XML data complies with the rules for a well-formed XML 1.0 document, as defined by the W3C. - - - + The XML data complies with the rules for a well-formed XML 1.0 document, 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 XML 1.0 document. @@ -159,15 +152,7 @@ 1 - The XML data is a well-formed XML fragment, as defined by the W3C. - - - + The XML data is a well-formed XML fragment, 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 XML 1.0 external parsed entity]. diff --git a/xml/System.Xml/DtdProcessing.xml b/xml/System.Xml/DtdProcessing.xml index c39879432fb..f8f61d07e38 100644 --- a/xml/System.Xml/DtdProcessing.xml +++ b/xml/System.Xml/DtdProcessing.xml @@ -31,7 +31,7 @@ property or the property. + This enumeration is set on the property or the property. ]]> @@ -67,17 +67,7 @@ 1 - Causes the DOCTYPE element to be ignored. No DTD processing occurs. - - [!IMPORTANT] -> The DTD/DOCTYPE will be lost on output. - - ]]> - + Causes the DOCTYPE element to be ignored. No DTD processing occurs, and the DTD/DOCTYPE is lost on output.. diff --git a/xml/System.Xml/EntityHandling.xml b/xml/System.Xml/EntityHandling.xml index 259e9312e8c..00ebceba686 100644 --- a/xml/System.Xml/EntityHandling.xml +++ b/xml/System.Xml/EntityHandling.xml @@ -59,17 +59,12 @@ 2 - Expands character entities and returns general entities as nodes. - - Expands character entities and returns general entities as nodes. + +You must call 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 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 method expands all entities (both general and character entities). - - ]]> - +When set to , a reader call to the method expands all entities (both general and character entities). + @@ -101,15 +96,10 @@ 1 - Expands all entities and returns the expanded nodes. - - nodes are not returned. The entity text is expanded in place of the entity references. - - ]]> - + Expands all entities and returns the expanded nodes. + + nodes are not returned. The entity text is expanded in place of the entity references. + diff --git a/xml/System.Xml/Formatting.xml b/xml/System.Xml/Formatting.xml index 47675a08fee..3e290f8ab75 100644 --- a/xml/System.Xml/Formatting.xml +++ b/xml/System.Xml/Formatting.xml @@ -58,15 +58,11 @@ 1 - Causes child elements to be indented according to the and settings. - - - + Causes child elements to be indented according to the and 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 Element Content and Mixed Content. + + diff --git a/xml/System.Xml/ValidationType.xml b/xml/System.Xml/ValidationType.xml index eb8fba10ad7..f6b61f8ede5 100644 --- a/xml/System.Xml/ValidationType.xml +++ b/xml/System.Xml/ValidationType.xml @@ -73,17 +73,10 @@ 1 - Validates if DTD or schema information is found. - - [!NOTE] -> This field is obsolete in the Microsoft .NET Framework version 2.0 and is applicable only to the class. - - ]]> - + Validates if DTD or schema information is found. + +Starting with .NET Framework 2.0, this field is obsolete. It applies only to the obsolete class. + @@ -147,17 +140,10 @@ 0 - No validation is performed. This setting creates an XML 1.0 compliant non-validating parser. - - . The DOCTYPE is not used for validation purposes. - - No validation errors are thrown. - - ]]> - + No validation is performed, and no validation errors are thrown. This setting creates an XML 1.0 compliant non-validating parser. + +Calls to report default attributes and resolve general enttities. The DOCTYPE is not used for validation purposes. + @@ -226,17 +212,10 @@ 3 - Validate according to XML-Data Reduced (XDR) schemas, including inline XDR schemas. XDR schemas are recognized using the namespace prefix or the property. - - [!NOTE] -> This field is obsolete in the Microsoft .NET Framework version 2.0 and is applicable only to the class. - - ]]> - + Validate according to XML-Data Reduced (XDR) schemas, including inline XDR schemas. XDR schemas are recognized using the namespace prefix or the property. + +Starting with .NET Framework 2.0, this field is obsolete. It applies only to the obsolete class. + diff --git a/xml/System.Xml/WriteState.xml b/xml/System.Xml/WriteState.xml index 5650191ba3a..cc0fd278016 100644 --- a/xml/System.Xml/WriteState.xml +++ b/xml/System.Xml/WriteState.xml @@ -203,17 +203,10 @@ 6 - An exception has been thrown, which has left the in an invalid state. You can call the method to put the in the state. Any other method calls results in an . - - [!NOTE] -> This field was added in the [!INCLUDE[dnprdnext](~/includes/dnprdnext-md.md)] release. - - ]]> - + An exception has been thrown, which has left the in an invalid state. You can call the method to put the in the state. Any other method calls results in an . + +This field was added in .NET Framework 2.0. + diff --git a/xml/System.Xml/XmlDateTimeSerializationMode.xml b/xml/System.Xml/XmlDateTimeSerializationMode.xml index d1f70e37a14..1dc80a03c62 100644 --- a/xml/System.Xml/XmlDateTimeSerializationMode.xml +++ b/xml/System.Xml/XmlDateTimeSerializationMode.xml @@ -31,7 +31,7 @@ and methods. + This enumeration is used by the and methods. ]]> @@ -133,15 +133,7 @@ 2 - Treat as a local time if a is being converted to a string. - - , convert to a local time if a time zone is specified. - - ]]> - + Treat as a local time if a is being converted to a string. If a string is being converted to , convert to a local time if a time zone is specified. diff --git a/xml/System.Xml/XmlNodeType.xml b/xml/System.Xml/XmlNodeType.xml index 281fa08c469..3aa49640e55 100644 --- a/xml/System.Xml/XmlNodeType.xml +++ b/xml/System.Xml/XmlNodeType.xml @@ -29,7 +29,36 @@ Specifies the type of node. - To be added. + + gets to the end of an element.| | | +|`EndEntity`| | | | +|`Entity`| |Child nodes that represent the expanded entity (for example, `Text` and `EntityReference` nodes) |`DocumentType`| +|`EntityReference`| |`Element`, `ProcessingInstruction`, `Comment`, `Text`, `CDATA`, `EntityReference` |`Attribute`, `DocumentFragment`, `Element`, `EntityReference` | +|`None`| | | | +|`Notation`| | None | `DocumentType`| +|`ProcessingInstruction`| | None | `Document`, `DocumentFragment`, `Element`, `EntityReference`| +|`SignificantWhitespace`| | | | +|`Text`| | None | `Attribute`, `DocumentFragment`, `Element`, `EntityReference` | +|`Whitespace`| | | | +|`XmlDeclaration`| Must be the first node in the document. It can have attributes that provide version and encoding information. |None|`Document`| + + ]]> + @@ -65,14 +94,6 @@ 2 An attribute (for example, id='123' ). - - - @@ -108,14 +129,6 @@ 4 A CDATA section (for example, <![CDATA[my escaped text]]> ). - - - @@ -151,14 +164,6 @@ 8 A comment (for example, <!-- my comment --> ). - - - @@ -194,14 +199,6 @@ 9 A document object that, as the root of the document tree, provides access to the entire XML document. - - - @@ -237,15 +234,7 @@ 11 A document fragment. - - - - + @@ -280,14 +269,6 @@ 10 The document type declaration, indicated by the following tag (for example, <!DOCTYPE...> ). - - - @@ -323,14 +304,6 @@ 1 An element (for example, <item> ). - - - @@ -366,14 +339,6 @@ 15 An end element tag (for example, </item> ). - - gets to the end of an element. - - ]]> - @@ -444,14 +409,6 @@ 6 An entity declaration (for example, <!ENTITY...> ). - - - @@ -487,14 +444,6 @@ 5 A reference to an entity (for example, &num; ). - - - @@ -565,14 +514,6 @@ 12 A notation in the document type declaration (for example, <!NOTATION...> ). - - - @@ -608,14 +549,6 @@ 7 A processing instruction (for example, <?pi test?> ). - - - From d2eab95d8d7ee3c32f9620c8587a8d076d28c6ea Mon Sep 17 00:00:00 2001 From: Ron Petrusha Date: Wed, 13 Feb 2019 00:08:13 -0800 Subject: [PATCH 2/3] Replaced xref with cref --- xml/System.Xml/XmlDateTimeSerializationMode.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xml/System.Xml/XmlDateTimeSerializationMode.xml b/xml/System.Xml/XmlDateTimeSerializationMode.xml index 1dc80a03c62..fcc30a3dcee 100644 --- a/xml/System.Xml/XmlDateTimeSerializationMode.xml +++ b/xml/System.Xml/XmlDateTimeSerializationMode.xml @@ -133,7 +133,7 @@ 2 - Treat as a local time if a is being converted to a string. If a string is being converted to , convert to a local time if a time zone is specified. + Treat as a local time if a is being converted to a string. If a string is being converted to , convert to a local time if a time zone is specified. From f7b4f54ab9cfca80e5e83cb0ebaca3382a657df0 Mon Sep 17 00:00:00 2001 From: Maira Wenzel Date: Wed, 13 Feb 2019 18:23:13 -0800 Subject: [PATCH 3/3] Apply suggestions from code review Accepted reviewer suggestions. Thanks, @mairaw. Co-Authored-By: rpetrusha --- xml/System.Xml/ConformanceLevel.xml | 4 ++-- xml/System.Xml/DtdProcessing.xml | 4 ++-- xml/System.Xml/Formatting.xml | 4 ++-- xml/System.Xml/ValidationType.xml | 6 +++--- xml/System.Xml/XmlNodeType.xml | 4 ++-- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/xml/System.Xml/ConformanceLevel.xml b/xml/System.Xml/ConformanceLevel.xml index b31cdbf3144..a1f1a8b8ee4 100644 --- a/xml/System.Xml/ConformanceLevel.xml +++ b/xml/System.Xml/ConformanceLevel.xml @@ -36,7 +36,7 @@ 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: + 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. @@ -156,4 +156,4 @@ - \ No newline at end of file + diff --git a/xml/System.Xml/DtdProcessing.xml b/xml/System.Xml/DtdProcessing.xml index f8f61d07e38..b30cf12c198 100644 --- a/xml/System.Xml/DtdProcessing.xml +++ b/xml/System.Xml/DtdProcessing.xml @@ -67,7 +67,7 @@ 1 - Causes the DOCTYPE element to be ignored. No DTD processing occurs, and the DTD/DOCTYPE is lost on output.. + Causes the DOCTYPE element to be ignored. No DTD processing occurs, and the DTD/DOCTYPE is lost on output. @@ -134,4 +134,4 @@ - \ No newline at end of file + diff --git a/xml/System.Xml/Formatting.xml b/xml/System.Xml/Formatting.xml index 3e290f8ab75..18aaede4f0e 100644 --- a/xml/System.Xml/Formatting.xml +++ b/xml/System.Xml/Formatting.xml @@ -60,7 +60,7 @@ Causes child elements to be indented according to the and 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 Element Content and Mixed Content. +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 Element Content and Mixed Content. @@ -98,4 +98,4 @@ This option indents element content only; mixed content is not affected. For the - \ No newline at end of file + diff --git a/xml/System.Xml/ValidationType.xml b/xml/System.Xml/ValidationType.xml index f6b61f8ede5..33a313cd81e 100644 --- a/xml/System.Xml/ValidationType.xml +++ b/xml/System.Xml/ValidationType.xml @@ -75,7 +75,7 @@ Validates if DTD or schema information is found. -Starting with .NET Framework 2.0, this field is obsolete. It applies only to the obsolete class. +Starting with .NET Framework 2.0, this field is obsolete. It applies only to the obsolete class. @@ -214,9 +214,9 @@ Calls to report default attr Validate according to XML-Data Reduced (XDR) schemas, including inline XDR schemas. XDR schemas are recognized using the namespace prefix or the property. -Starting with .NET Framework 2.0, this field is obsolete. It applies only to the obsolete class. +Starting with .NET Framework 2.0, this field is obsolete. It applies only to the obsolete class. - \ No newline at end of file + diff --git a/xml/System.Xml/XmlNodeType.xml b/xml/System.Xml/XmlNodeType.xml index 3aa49640e55..f9c2739c14e 100644 --- a/xml/System.Xml/XmlNodeType.xml +++ b/xml/System.Xml/XmlNodeType.xml @@ -37,7 +37,7 @@ The following table provides additional information about XML nodes, as well as their parent and child nodes. | Field | Description | Can have child nodes: | Can be a child node of: | -|---|---|---|---} +|---|---|---|---| |`Attribute`| |`EntityReference`, `Text`|None. It is not considered a child node of an `Element`.| |`CDATA`| CDATA sections are used to escape blocks of text that would otherwise be recognized as markup.|None.|`DocumentFragment`, `EntityReference`, and `Element`| |`Comment`| | None. |`Document`, `DocumentFragment`, `EntityReference`| @@ -708,4 +708,4 @@ The following table provides additional information about XML nodes, as well as - \ No newline at end of file +