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.

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

Update ProductInfoHeaderValue.xml #7319

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
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
26 changes: 20 additions & 6 deletions xml/System.Net.Http.Headers/ProductInfoHeaderValue.xml
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@
<format type="text/markdown"><![CDATA[

## Remarks
The <xref:System.Net.Http.Headers.ProductInfoHeaderValue> class provides support for the product and comment tokens values used in a User-Agent header as defined in [RFC 2616](https://go.microsoft.com/fwlink/?LinkID=241642) by the IETF.
The <xref:System.Net.Http.Headers.ProductInfoHeaderValue> class provides support for the product and comment tokens values used in a User-Agent header as defined in [RFC 2616](https://go.microsoft.com/fwlink/?LinkID=241642) by the IETF.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why link it as fwlink?
Also 2616 has been obsoleted, twice already, the newest RFC is here: https://www.rfc-editor.org/rfc/rfc9110#field.user-agent


The User-Agent field contains information about the user agent originating the request. The field can contain multiple product tokens and comments identifying the user agent and any sub-products.

Expand Down Expand Up @@ -93,7 +93,7 @@
</Parameters>
<Docs>
<param name="product">A <see cref="T:System.Net.Http.Headers.ProductHeaderValue" /> object used to initialize the new instance.</param>
<summary>Initializes a new instance of the <see cref="T:System.Net.Http.Headers.ProductInfoHeaderValue" /> class.</summary>
<summary>Initializes a new instance of the <see cref="T:System.Net.Http.Headers.ProductInfoHeaderValue" /> class, using a product token from a <see cref="T:System.Net.Http.Headers.ProductHeaderValue" /> object.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
Expand Down Expand Up @@ -126,8 +126,15 @@
</Parameters>
<Docs>
<param name="comment">A comment value.</param>
<summary>Initializes a new instance of the <see cref="T:System.Net.Http.Headers.ProductInfoHeaderValue" /> class.</summary>
<remarks>To be added.</remarks>
<summary>Initializes a new instance of the <see cref="T:System.Net.Http.Headers.ProductInfoHeaderValue" /> class with a comment.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The syntax of a comment is defined in [RFC 2616](https://go.microsoft.com/fwlink/?LinkID=241642)

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -162,8 +169,15 @@
<Docs>
<param name="productName">The product name value.</param>
<param name="productVersion">The product version value.</param>
<summary>Initializes a new instance of the <see cref="T:System.Net.Http.Headers.ProductInfoHeaderValue" /> class.</summary>
<remarks>To be added.</remarks>
<summary>Initializes a new instance of the <see cref="T:System.Net.Http.Headers.ProductInfoHeaderValue" /> class with product information.</summary>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks
The syntax of product information (name and value) is defined in [RFC 2616](https://go.microsoft.com/fwlink/?LinkID=241642)

]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="Comment">
Expand Down