Skip to content

Commit 6e5d9f5

Browse files
krwqcarlossanlop
krwq
and
carlossanlop
authored
Add documentation to XmlDocumentXPathExtensions (#4316)
* add documentation to XmlDocumentXPathExtensions * Update xml/System.Xml/XmlDocumentXPathExtensions.xml Co-authored-by: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Xml/XmlDocumentXPathExtensions.xml Co-authored-by: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Xml/XmlDocumentXPathExtensions.xml Co-authored-by: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Xml/XmlDocumentXPathExtensions.xml Co-authored-by: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Xml/XmlDocumentXPathExtensions.xml Co-authored-by: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Xml/XmlDocumentXPathExtensions.xml Co-authored-by: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Xml/XmlDocumentXPathExtensions.xml Co-authored-by: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Xml/XmlDocumentXPathExtensions.xml Co-authored-by: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Xml/XmlDocumentXPathExtensions.xml Co-authored-by: Carlos Sanchez Lopez <[email protected]> * Update xml/System.Xml/XmlDocumentXPathExtensions.xml Co-authored-by: Carlos Sanchez Lopez <[email protected]> Co-authored-by: Carlos Sanchez Lopez <[email protected]>
1 parent fd52d6a commit 6e5d9f5

File tree

1 file changed

+35
-32
lines changed

1 file changed

+35
-32
lines changed

‎xml/System.Xml/XmlDocumentXPathExtensions.xml

Lines changed: 35 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
</Base>
1717
<Interfaces />
1818
<Docs>
19-
<summary>To be added.</summary>
19+
<summary>Provides extension methods for the <see cref="T:System.Xml.XmlDocument" /> and <see cref="T:System.Xml.XmlNode" /> for document navigation.</summary>
2020
<remarks>To be added.</remarks>
2121
</Docs>
2222
<Members>
@@ -41,9 +41,9 @@
4141
<Parameter Name="document" Type="System.Xml.XmlDocument" RefType="this" />
4242
</Parameters>
4343
<Docs>
44-
<param name="document">To be added.</param>
45-
<summary>To be added.</summary>
46-
<returns>To be added.</returns>
44+
<param name="document">The document from which the XPath navigator is created.</param>
45+
<summary>Creates a new XPath navigator object for navigating the specified document.</summary>
46+
<returns>An XPath navigator object.</returns>
4747
<remarks>To be added.</remarks>
4848
</Docs>
4949
</Member>
@@ -68,9 +68,9 @@
6868
<Parameter Name="node" Type="System.Xml.XmlNode" RefType="this" />
6969
</Parameters>
7070
<Docs>
71-
<param name="node">To be added.</param>
72-
<summary>To be added.</summary>
73-
<returns>To be added.</returns>
71+
<param name="node">The node where the navigator is initially positioned.</param>
72+
<summary>Creates an XPath navigator for navigating the specified node.</summary>
73+
<returns>An XPath navigator object used to navigate the node. The XPath navigator is positioned on the node from which the method is called, not on the root of the document.</returns>
7474
<remarks>To be added.</remarks>
7575
</Docs>
7676
</Member>
@@ -96,10 +96,10 @@
9696
<Parameter Name="node" Type="System.Xml.XmlNode" />
9797
</Parameters>
9898
<Docs>
99-
<param name="document">To be added.</param>
100-
<param name="node">To be added.</param>
101-
<summary>To be added.</summary>
102-
<returns>To be added.</returns>
99+
<param name="document">The document from which the XPath navigator is created.</param>
100+
<param name="node">The node where the navigator is initially positioned.</param>
101+
<summary>Creates an XPath navigator object for navigating the specified document positioned on the specified node.</summary>
102+
<returns>An XPath navigator object.</returns>
103103
<remarks>To be added.</remarks>
104104
</Docs>
105105
</Member>
@@ -125,10 +125,10 @@
125125
<Parameter Name="xpath" Type="System.String" />
126126
</Parameters>
127127
<Docs>
128-
<param name="node">To be added.</param>
129-
<param name="xpath">To be added.</param>
130-
<summary>To be added.</summary>
131-
<returns>To be added.</returns>
128+
<param name="node">The node where the navigator is initially positioned.</param>
129+
<param name="xpath">The XPath expression to match.</param>
130+
<summary>Selects a list of nodes matching the specified XPath expression.</summary>
131+
<returns>A collection of nodes that match the specified XPath expression.</returns>
132132
<remarks>To be added.</remarks>
133133
</Docs>
134134
</Member>
@@ -155,12 +155,13 @@
155155
<Parameter Name="nsmgr" Type="System.Xml.XmlNamespaceManager" />
156156
</Parameters>
157157
<Docs>
158-
<param name="node">To be added.</param>
159-
<param name="xpath">To be added.</param>
160-
<param name="nsmgr">To be added.</param>
161-
<summary>To be added.</summary>
162-
<returns>To be added.</returns>
158+
<param name="node">The node where the navigator is initially positioned.</param>
159+
<param name="xpath">The XPath expression to match.</param>
160+
<param name="nsmgr">A namespace manager to resolve XPath expression prefix namespaces.</param>
161+
<summary>Selects a list of nodes matching the specified XPath expression. Any prefixes found in the XPath expression are resolved using the supplied namespace manager.</summary>
162+
<returns>A collection of nodes that match the specified XPath expression.</returns>
163163
<remarks>To be added.</remarks>
164+
<related type="article" href="https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/ms256086(v=vs.100)">XPath examples</related>
164165
</Docs>
165166
</Member>
166167
<Member MemberName="SelectSingleNode">
@@ -185,11 +186,12 @@
185186
<Parameter Name="xpath" Type="System.String" />
186187
</Parameters>
187188
<Docs>
188-
<param name="node">To be added.</param>
189-
<param name="xpath">To be added.</param>
190-
<summary>To be added.</summary>
191-
<returns>To be added.</returns>
189+
<param name="node">The node where the navigator is initially positioned.</param>
190+
<param name="xpath">The XPath expression to match.</param>
191+
<summary>Selects the first node that matches the XPath expression.</summary>
192+
<returns>The first node that matches the XPath query, or <see langword="null" /> if no matching node is found.</returns>
192193
<remarks>To be added.</remarks>
194+
<related type="article" href="https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/ms256086(v=vs.100)">XPath examples</related>
193195
</Docs>
194196
</Member>
195197
<Member MemberName="SelectSingleNode">
@@ -215,12 +217,13 @@
215217
<Parameter Name="nsmgr" Type="System.Xml.XmlNamespaceManager" />
216218
</Parameters>
217219
<Docs>
218-
<param name="node">To be added.</param>
219-
<param name="xpath">To be added.</param>
220-
<param name="nsmgr">To be added.</param>
221-
<summary>To be added.</summary>
222-
<returns>To be added.</returns>
220+
<param name="node">The node where the navigator is initially positioned.</param>
221+
<param name="xpath">The XPath expression to match.</param>
222+
<param name="nsmgr">A namespace manager to resolve XPath expression prefix namespaces.</param>
223+
<summary>Selects the first node that matches the XPath expression. Any prefixes found in the XPath expression are resolved using the supplied namespace manager.</summary>
224+
<returns>The first node that matches the XPath query, or <see langword="null" /> if no matching node is found.</returns>
223225
<remarks>To be added.</remarks>
226+
<related type="article" href="https://docs.microsoft.com/previous-versions/dotnet/netframework-4.0/ms256086(v=vs.100)">XPath examples</related>
224227
</Docs>
225228
</Member>
226229
<Member MemberName="ToXPathNavigable">
@@ -244,9 +247,9 @@
244247
<Parameter Name="node" Type="System.Xml.XmlNode" RefType="this" />
245248
</Parameters>
246249
<Docs>
247-
<param name="node">To be added.</param>
248-
<summary>To be added.</summary>
249-
<returns>To be added.</returns>
250+
<param name="node">The node in which the implementation should position newly created navigators.</param>
251+
<summary>Creates an <see cref="T:System.Xml.XPath.IXPathNavigable" /> instance used for producing navigators.</summary>
252+
<returns>An <see cref="T:System.Xml.XPath.IXPathNavigable" /> instance.</returns>
250253
<remarks>To be added.</remarks>
251254
</Docs>
252255
</Member>

0 commit comments

Comments
 (0)