Skip to content

Commit 9acd94d

Browse files
gewarrengewarren
committed
delete code example text from obsolete types
1 parent a33f8fb commit 9acd94d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+845
-2240
lines changed

‎xml/System.Web.Configuration/PassportAuthentication.xml

Lines changed: 1 addition & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -33,20 +33,6 @@
3333
> [!NOTE]
3434
> The <xref:System.Web.Configuration.PassportAuthentication> class can write information into the related section of the configuration file at machine, site, or application level only. Any attempt to write in a configuration file at a different level in the hierarchy will result in an error message generated by the parser. You can use this class to read configuration information at any level in the hierarchy.
3535
36-
37-
38-
## Examples
39-
The following code example shows how to obtain the <xref:System.Web.Configuration.PassportAuthentication> object from the configuration file of an existing Web application. Also shown is a configuration example.
40-
41-
```xml
42-
<authentication>
43-
<passport redirectUrl="Login.aspx"/>
44-
</authentication>
45-
```
46-
47-
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PassportAuthentication/CS/passportauthentication.cs" id="Snippet1":::
48-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PassportAuthentication/VB/passportauthentication.vb" id="Snippet1":::
49-
5036
]]></format>
5137
</remarks>
5238
<altmember cref="T:System.Web.Configuration.AuthenticationSection" />
@@ -76,17 +62,7 @@
7662
<Parameters />
7763
<Docs>
7864
<summary>Initializes a new instance of the <see cref="T:System.Web.Configuration.PassportAuthentication" /> class.</summary>
79-
<remarks>
80-
<format type="text/markdown"><![CDATA[
81-
82-
## Examples
83-
The following code example shows how to create a <xref:System.Web.Configuration.PassportAuthentication> object.
84-
85-
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PassportAuthentication/CS/passportauthentication.cs" id="Snippet2":::
86-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PassportAuthentication/VB/passportauthentication.vb" id="Snippet2":::
87-
88-
]]></format>
89-
</remarks>
65+
<remarks>To be added.</remarks>
9066
</Docs>
9167
</Member>
9268
<Member MemberName="ElementProperty">
@@ -180,14 +156,6 @@
180156
## Remarks
181157
The <xref:System.Web.Configuration.PassportAuthentication.RedirectUrl%2A> specifies the URL of the page to which the request must be redirected if Passport authentication is required and the user has not signed on using Passport authentication.
182158
183-
184-
185-
## Examples
186-
The following code example shows how to use the <xref:System.Web.Configuration.PassportAuthentication.RedirectUrl%2A> property.
187-
188-
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.Configuration.PassportAuthentication/CS/passportauthentication.cs" id="Snippet3":::
189-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Configuration.PassportAuthentication/VB/passportauthentication.vb" id="Snippet3":::
190-
191159
]]></format>
192160
</remarks>
193161
</Docs>

‎xml/System.Web.Mail/MailAttachment.xml

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -56,17 +56,11 @@
5656
<param name="filename">The name of the attachment file.</param>
5757
<summary>Initializes a new instance of the <see cref="T:System.Web.Mail.MailAttachment" /> class with the specified file name for the attachment. Sets the <see cref="T:System.Text.Encoding" /> property to <see cref="F:System.Web.Mail.MailEncoding.UUEncode" /> by default. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
5858
<remarks>
59-
<format type="text/markdown"><![CDATA[
60-
61-
## Remarks
62-
The mail attachment file is locked while the mail is being sent.
63-
64-
65-
66-
## Examples
67-
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/SystemWebMailMailAttachment/CS/systemwebmailmailattachment.cs" id="Snippet1":::
68-
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/SystemWebMailMailAttachment/VB/systemwebmailmailattachment.vb" id="Snippet1":::
69-
59+
<format type="text/markdown"><![CDATA[
60+
61+
## Remarks
62+
The mail attachment file is locked while the mail is being sent.
63+
7064
]]></format>
7165
</remarks>
7266
</Docs>

‎xml/System.Web.Mail/MailMessage.xml

Lines changed: 25 additions & 125 deletions
Original file line numberDiff line numberDiff line change
@@ -22,21 +22,8 @@
2222
</Attribute>
2323
</Attributes>
2424
<Docs>
25-
<summary>Provides properties and methods for constructing an email message. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
26-
<remarks>
27-
<format type="text/markdown"><![CDATA[
28-
29-
## Examples
30-
The following example shows how to use the <xref:System.Web.Mail.MailMessage> class.
31-
32-
> [!IMPORTANT]
33-
> This control has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://learn.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)).
34-
35-
[!code-aspx-csharp[System.Web.Mail.MailMessage#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Mail.MailMessage/CS/mailformcs.aspx#1)]
36-
[!code-aspx-vb[System.Web.Mail.MailMessage#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Mail.MailMessage/VB/mailformvb.aspx#1)]
37-
38-
]]></format>
39-
</remarks>
25+
<summary>Provides properties and methods for constructing an email message.</summary>
26+
<remarks>To be added.</remarks>
4027
</Docs>
4128
<Members>
4229
<Member MemberName=".ctor">
@@ -54,7 +41,7 @@
5441
</AssemblyInfo>
5542
<Parameters />
5643
<Docs>
57-
<summary>Initializes a new instance of the <see cref="T:System.Web.Mail.MailMessage" /> class. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
44+
<summary>Initializes a new instance of the <see cref="T:System.Web.Mail.MailMessage" /> class.</summary>
5845
<remarks>To be added.</remarks>
5946
</Docs>
6047
</Member>
@@ -82,22 +69,9 @@
8269
<ReturnType>System.Collections.IList</ReturnType>
8370
</ReturnValue>
8471
<Docs>
85-
<summary>Specifies the collection of attachments that are transmitted with the message. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
72+
<summary>Specifies the collection of attachments that are transmitted with the message.</summary>
8673
<value>An <see cref="T:System.Collections.IList" /> collection of <see cref="T:System.Web.Mail.MailAttachment" /> objects.</value>
87-
<remarks>
88-
<format type="text/markdown"><![CDATA[
89-
90-
## Remarks
91-
New attachments can be added to the mail message by a call to `Message.Attachments.Add(MyMailMessage)`. See <xref:System.Web.Mail.SmtpMail.Send%2A> for an example of <xref:System.Web.Mail.SmtpMail> usage.
92-
93-
94-
95-
## Examples
96-
[!code-csharp[System.Web.Mail.MailMessage.Attachments#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Mail.MailMessage.Attachments/CS/attachmentsample.cs#1)]
97-
[!code-vb[System.Web.Mail.MailMessage.Attachments#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Mail.MailMessage.Attachments/VB/attachmentsample.vb#1)]
98-
99-
]]></format>
100-
</remarks>
74+
<remarks>To be added.</remarks>
10175
</Docs>
10276
</Member>
10377
<Member MemberName="Bcc">
@@ -128,7 +102,7 @@
128102
<ReturnType>System.String</ReturnType>
129103
</ReturnValue>
130104
<Docs>
131-
<summary>Gets or sets a semicolon-delimited list of email addresses that receive a blind carbon copy (BCC) of the email message. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
105+
<summary>Gets or sets a semicolon-delimited list of email addresses that receive a blind carbon copy (BCC) of the email message.</summary>
132106
<value>A semicolon-delimited list of email addresses that receive a blind carbon copy (BCC) of the email message.</value>
133107
<remarks>
134108
<format type="text/markdown"><![CDATA[
@@ -138,12 +112,6 @@
138112
139113
The primary and carbon copy (<xref:System.Web.Mail.MailMessage.Cc%2A>) recipients do not see the addresses in the `Bcc` field.
140114
141-
142-
143-
## Examples
144-
[!code-csharp[System.Web.Mail.MailMessage.Bcc#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Mail.MailMessage.Bcc/CS/systemwebmailmailmessagebcc.cs#1)]
145-
[!code-vb[System.Web.Mail.MailMessage.Bcc#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Mail.MailMessage.Bcc/VB/systemwebmailmailmessagebcc.vb#1)]
146-
147115
]]></format>
148116
</remarks>
149117
</Docs>
@@ -176,7 +144,7 @@
176144
<ReturnType>System.String</ReturnType>
177145
</ReturnValue>
178146
<Docs>
179-
<summary>Gets or sets the body of the email message. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
147+
<summary>Gets or sets the body of the email message.</summary>
180148
<value>The body of the email message.</value>
181149
<remarks>To be added.</remarks>
182150
</Docs>
@@ -209,17 +177,9 @@
209177
<ReturnType>System.Text.Encoding</ReturnType>
210178
</ReturnValue>
211179
<Docs>
212-
<summary>Gets or sets the encoding type of the body of the email message. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
180+
<summary>Gets or sets the encoding type of the body of the email message.</summary>
213181
<value>One of the <see cref="T:System.Text.Encoding" /> values that indicates the encoding type of the body of the email message.</value>
214-
<remarks>
215-
<format type="text/markdown"><![CDATA[
216-
217-
## Examples
218-
[!code-csharp[System.Web.Mail.MailMessage.BodyEncoding#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Mail.MailMessage.BodyEncoding/CS/systemwebmailmailmessagebodyencoding.cs#1)]
219-
[!code-vb[System.Web.Mail.MailMessage.BodyEncoding#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Mail.MailMessage.BodyEncoding/VB/systemwebmailmailmessagebodyencoding.vb#1)]
220-
221-
]]></format>
222-
</remarks>
182+
<remarks>To be added.</remarks>
223183
</Docs>
224184
</Member>
225185
<Member MemberName="BodyFormat">
@@ -250,17 +210,9 @@
250210
<ReturnType>System.Web.Mail.MailFormat</ReturnType>
251211
</ReturnValue>
252212
<Docs>
253-
<summary>Gets or sets the content type of the body of the email message. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
213+
<summary>Gets or sets the content type of the body of the email message.</summary>
254214
<value>One of the <see cref="T:System.Web.Mail.MailFormat" /> values.</value>
255-
<remarks>
256-
<format type="text/markdown"><![CDATA[
257-
258-
## Examples
259-
[!code-csharp[System.Web.Mail.MailMessage.BodyFormat#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Mail.MailMessage.BodyFormat/CS/systemwebmailmailmessagebodyformat.cs#1)]
260-
[!code-vb[System.Web.Mail.MailMessage.BodyFormat#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Mail.MailMessage.BodyFormat/VB/systemwebmailmailmessagebodyformat.vb#1)]
261-
262-
]]></format>
263-
</remarks>
215+
<remarks>To be added.</remarks>
264216
</Docs>
265217
</Member>
266218
<Member MemberName="Cc">
@@ -291,20 +243,14 @@
291243
<ReturnType>System.String</ReturnType>
292244
</ReturnValue>
293245
<Docs>
294-
<summary>Gets or sets a semicolon-delimited list of email addresses that receive a carbon copy (CC) of the email message. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
246+
<summary>Gets or sets a semicolon-delimited list of email addresses that receive a carbon copy (CC) of the email message.</summary>
295247
<value>A semicolon-delimited list of email addresses that receive a carbon copy (CC) of the email message.</value>
296248
<remarks>
297249
<format type="text/markdown"><![CDATA[
298250
299251
## Remarks
300252
Recipients in the semicolon-delimited list can be either email addresses or address book display names.
301253
302-
303-
304-
## Examples
305-
[!code-csharp[System.Web.Mail.MailMessage.Cc#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Mail.MailMessage.Cc/CS/systemwebmailmailmessagecc.cs#1)]
306-
[!code-vb[System.Web.Mail.MailMessage.Cc#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Mail.MailMessage.Cc/VB/systemwebmailmailmessagecc.vb#1)]
307-
308254
]]></format>
309255
</remarks>
310256
</Docs>
@@ -333,21 +279,13 @@
333279
<ReturnType>System.Collections.IDictionary</ReturnType>
334280
</ReturnValue>
335281
<Docs>
336-
<summary>Gets a collection of objects that map to Microsoft Collaboration Data Objects (CDO) fields. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
282+
<summary>Gets a collection of objects that map to Microsoft Collaboration Data Objects (CDO) fields.</summary>
337283
<value>An <see cref="T:System.Collections.IDictionary" /> collection of objects that map to Collaboration Data Objects (CDO) fields.</value>
338284
<remarks>
339285
<format type="text/markdown"><![CDATA[
340286
341287
## Remarks
342-
The <xref:System.Web.Mail.MailMessage.Fields%2A> property is used to set extended properties for Collaboration Data Objects (CDO). For more information about CDO, see [Collaboration Data Objects](https://learn.microsoft.com/archive/msdn-magazine/2000/june/collaboration-data-objects-send-microsoft-exchange-appointment-reminders-to-your-pager-using-cdo) and [Configuration CoClass](https://learn.microsoft.com/previous-versions/office/developer/exchange-server-2003/ms870485(v=exchg.65)).
343-
344-
345-
346-
## Examples
347-
The following code example demonstrates using the <xref:System.Web.Mail.MailMessage.Fields%2A> property to send your user name and password to a Simple Mail Transfer Protocol (SMTP) server for authentication.
348-
349-
[!code-csharp[System.Web.Mail.MailMessage.Fields#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Mail.MailMessage.Fields/CS/MailMessageFieldscs.aspx#1)]
350-
[!code-vb[System.Web.Mail.MailMessage.Fields#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Mail.MailMessage.Fields/VB/MailMessageFieldsvb.aspx#1)]
288+
The <xref:System.Web.Mail.MailMessage.Fields%2A> property is used to set extended properties for Collaboration Data Objects (CDO). For more information about CDO, see [Collaboration Data Objects](https://learn.microsoft.com/archive/msdn-magazine/2000/june/collaboration-data-objects-send-microsoft-exchange-appointment-reminders-to-your-pager-using-cdo).
351289
352290
]]></format>
353291
</remarks>
@@ -381,17 +319,9 @@
381319
<ReturnType>System.String</ReturnType>
382320
</ReturnValue>
383321
<Docs>
384-
<summary>Gets or sets the email address of the sender. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
322+
<summary>Gets or sets the email address of the sender.</summary>
385323
<value>The sender's email address.</value>
386-
<remarks>
387-
<format type="text/markdown"><![CDATA[
388-
389-
## Examples
390-
[!code-csharp[SystemWebMailMailMessageFrom#1](~/snippets/csharp/VS_Snippets_WebNet/SystemWebMailMailMessageFrom/CS/systemwebmailmailmessagefrom.cs#1)]
391-
[!code-vb[SystemWebMailMailMessageFrom#1](~/snippets/visualbasic/VS_Snippets_WebNet/SystemWebMailMailMessageFrom/VB/systemwebmailmailmessagefrom.vb#1)]
392-
393-
]]></format>
394-
</remarks>
324+
<remarks>To be added.</remarks>
395325
</Docs>
396326
</Member>
397327
<Member MemberName="Headers">
@@ -418,7 +348,7 @@
418348
<ReturnType>System.Collections.IDictionary</ReturnType>
419349
</ReturnValue>
420350
<Docs>
421-
<summary>Specifies the custom headers that are transmitted with the email message. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
351+
<summary>Specifies the custom headers that are transmitted with the email message.</summary>
422352
<value>An <see cref="T:System.Collections.IDictionary" /> collection of custom headers.</value>
423353
<remarks>To be added.</remarks>
424354
</Docs>
@@ -451,17 +381,9 @@
451381
<ReturnType>System.Web.Mail.MailPriority</ReturnType>
452382
</ReturnValue>
453383
<Docs>
454-
<summary>Gets or sets the priority of the email message. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
384+
<summary>Gets or sets the priority of the email message.</summary>
455385
<value>One of the <see cref="T:System.Web.Mail.MailPriority" /> values.</value>
456-
<remarks>
457-
<format type="text/markdown"><![CDATA[
458-
459-
## Examples
460-
[!code-csharp[System.Web.Mail.MailMessage.Priority#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Mail.MailMessage.Priority/CS/systemwebmailmailmessagepriority.cs#1)]
461-
[!code-vb[System.Web.Mail.MailMessage.Priority#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Mail.MailMessage.Priority/VB/systemwebmailmailmessagepriority.vb#1)]
462-
463-
]]></format>
464-
</remarks>
386+
<remarks>To be added.</remarks>
465387
</Docs>
466388
</Member>
467389
<Member MemberName="Subject">
@@ -492,7 +414,7 @@
492414
<ReturnType>System.String</ReturnType>
493415
</ReturnValue>
494416
<Docs>
495-
<summary>Gets or sets the subject line of the email message. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
417+
<summary>Gets or sets the subject line of the email message.</summary>
496418
<value>The subject line of the email message.</value>
497419
<remarks>To be added.</remarks>
498420
</Docs>
@@ -525,20 +447,14 @@
525447
<ReturnType>System.String</ReturnType>
526448
</ReturnValue>
527449
<Docs>
528-
<summary>Gets or sets a semicolon-delimited list of recipient email addresses. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
450+
<summary>Gets or sets a semicolon-delimited list of recipient email addresses.</summary>
529451
<value>A semicolon-delimited list of email addresses.</value>
530452
<remarks>
531453
<format type="text/markdown"><![CDATA[
532454
533455
## Remarks
534456
Recipients in the semicolon-delimited list can be either email addresses or address book display names.
535457
536-
537-
538-
## Examples
539-
[!code-csharp[SystemWebMailMailMessageTo#1](~/snippets/csharp/VS_Snippets_WebNet/SystemWebMailMailMessageTo/CS/systemwebmailmailmessageto.cs#1)]
540-
[!code-vb[SystemWebMailMailMessageTo#1](~/snippets/visualbasic/VS_Snippets_WebNet/SystemWebMailMailMessageTo/VB/systemwebmailmailmessageto.vb#1)]
541-
542458
]]></format>
543459
</remarks>
544460
</Docs>
@@ -571,17 +487,9 @@
571487
<ReturnType>System.String</ReturnType>
572488
</ReturnValue>
573489
<Docs>
574-
<summary>Gets or sets the <see langword="Content-Base" /> HTTP header, the URL base of all relative URLs used within the HTML-encoded body of the email message. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
490+
<summary>Gets or sets the <see langword="Content-Base" /> HTTP header, the URL base of all relative URLs used within the HTML-encoded body of the email message.</summary>
575491
<value>The URL base.</value>
576-
<remarks>
577-
<format type="text/markdown"><![CDATA[
578-
579-
## Examples
580-
[!code-csharp[System.Web.Mail.MailMessage.UrlContentBase#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Mail.MailMessage.UrlContentBase/CS/systemwebmailmailmessageurlcontentbase.cs#1)]
581-
[!code-vb[System.Web.Mail.MailMessage.UrlContentBase#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Mail.MailMessage.UrlContentBase/VB/systemwebmailmailmessageurlcontentbase.vb#1)]
582-
583-
]]></format>
584-
</remarks>
492+
<remarks>To be added.</remarks>
585493
</Docs>
586494
</Member>
587495
<Member MemberName="UrlContentLocation">
@@ -612,17 +520,9 @@
612520
<ReturnType>System.String</ReturnType>
613521
</ReturnValue>
614522
<Docs>
615-
<summary>Gets or sets the <see langword="Content-Location" /> HTTP header for the email message. Recommended alternative: <see cref="N:System.Net.Mail" />.</summary>
523+
<summary>Gets or sets the <see langword="Content-Location" /> HTTP header for the email message.</summary>
616524
<value>The <see langword="content-base" /> header.</value>
617-
<remarks>
618-
<format type="text/markdown"><![CDATA[
619-
620-
## Examples
621-
[!code-aspx-csharp[System.Web.Mail.MailMessage#1](~/snippets/csharp/VS_Snippets_WebNet/System.Web.Mail.MailMessage/CS/mailformcs.aspx#1)]
622-
[!code-aspx-vb[System.Web.Mail.MailMessage#1](~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.Mail.MailMessage/VB/mailformvb.aspx#1)]
623-
624-
]]></format>
625-
</remarks>
525+
<remarks>To be added.</remarks>
626526
</Docs>
627527
</Member>
628528
</Members>

0 commit comments

Comments
 (0)