Skip to content

Commit e4df432

Browse files
authored
Add xml comments to System.Net.Mime.MediaTypeNames members (#92220)
* Add xml comments to MediaTypeNames members * Code review feedback
1 parent 963954a commit e4df432

File tree

1 file changed

+84
-0
lines changed

1 file changed

+84
-0
lines changed

src/libraries/System.Net.Mail/src/System/Net/Mime/MediaTypeNames.cs

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,65 +5,149 @@ namespace System.Net.Mime
55
{
66
public static class MediaTypeNames
77
{
8+
/// <summary>Specifies the kind of application data in an email message attachment.</summary>
89
public static class Application
910
{
11+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data consists of url-encoded key-value pairs.</summary>
1012
public const string FormUrlEncoded = "application/x-www-form-urlencoded";
13+
14+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is in JSON format.</summary>
1115
public const string Json = "application/json";
16+
17+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is in JSON patch format.</summary>
1218
public const string JsonPatch = "application/json-patch+json";
19+
20+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is in JSON text sequence format.</summary>
1321
public const string JsonSequence = "application/json-seq";
22+
23+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is in Web Application Manifest.</summary>
1424
public const string Manifest = "application/manifest+json";
25+
26+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is not interpreted.</summary>
1527
public const string Octet = "application/octet-stream";
28+
29+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is in Portable Document Format (PDF).</summary>
1630
public const string Pdf = "application/pdf";
31+
32+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is in JSON problem detail format.</summary>
1733
public const string ProblemJson = "application/problem+json";
34+
35+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is in XML problem detail format.</summary>
1836
public const string ProblemXml = "application/problem+xml";
37+
38+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is in Rich Text Format (RTF).</summary>
1939
public const string Rtf = "application/rtf";
40+
41+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is a SOAP document.</summary>
2042
public const string Soap = "application/soap+xml";
43+
44+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is in WASM format.</summary>
2145
public const string Wasm = "application/wasm";
46+
47+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is in XML format.</summary>
2248
public const string Xml = "application/xml";
49+
50+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is in XML Document Type Definition format.</summary>
2351
public const string XmlDtd = "application/xml-dtd";
52+
53+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is in XML patch format.</summary>
2454
public const string XmlPatch = "application/xml-patch+xml";
55+
56+
/// <summary>Specifies that the <see cref="MediaTypeNames.Application"/> data is compressed.</summary>
2557
public const string Zip = "application/zip";
2658
}
2759

60+
/// <summary>Specifies the kind of font data in an email message attachment.</summary>
2861
public static class Font
2962
{
63+
/// <summary>Specifies that the <see cref="MediaTypeNames.Font"/> data is in font type collection format.</summary>
3064
public const string Collection = "font/collection";
65+
66+
/// <summary>Specifies that the <see cref="MediaTypeNames.Font"/> data is in OpenType Layout (OTF) format.</summary>
3167
public const string Otf = "font/otf";
68+
69+
/// <summary>Specifies that the <see cref="MediaTypeNames.Font"/> data is in SFNT format.</summary>
3270
public const string Sfnt = "font/sfnt";
71+
72+
/// <summary>Specifies that the <see cref="MediaTypeNames.Font"/> data is in TrueType font (TTF) format.</summary>
3373
public const string Ttf = "font/ttf";
74+
75+
/// <summary>Specifies that the <see cref="MediaTypeNames.Font"/> data is in WOFF format.</summary>
3476
public const string Woff = "font/woff";
77+
78+
/// <summary>Specifies that the <see cref="MediaTypeNames.Font"/> data is in WOFF2 format.</summary>
3579
public const string Woff2 = "font/woff2";
3680
}
3781

82+
/// <summary>Specifies the kind of image data in an email message attachment.</summary>
3883
public static class Image
3984
{
85+
/// <summary>Specifies that the <see cref="MediaTypeNames.Image"/> data is in AVIF format.</summary>
4086
public const string Avif = "image/avif";
87+
88+
/// <summary>Specifies that the <see cref="MediaTypeNames.Image"/> data is in BMP format.</summary>
4189
public const string Bmp = "image/bmp";
90+
91+
/// <summary>Specifies that the <see cref="MediaTypeNames.Image"/> data is in GIF format.</summary>
4292
public const string Gif = "image/gif";
93+
94+
/// <summary>Specifies that the <see cref="MediaTypeNames.Image"/> data is in ICO format.</summary>
4395
public const string Icon = "image/x-icon";
96+
97+
/// <summary>Specifies that the <see cref="MediaTypeNames.Image"/> data is in JPEG format.</summary>
4498
public const string Jpeg = "image/jpeg";
99+
100+
/// <summary>Specifies that the <see cref="MediaTypeNames.Image"/> data is in PNG format.</summary>
45101
public const string Png = "image/png";
102+
103+
/// <summary>Specifies that the <see cref="MediaTypeNames.Image"/> data is in SVG format.</summary>
46104
public const string Svg = "image/svg+xml";
105+
106+
/// <summary>Specifies that the <see cref="MediaTypeNames.Image"/> data is in TIFF format.</summary>
47107
public const string Tiff = "image/tiff";
108+
109+
/// <summary>Specifies that the <see cref="MediaTypeNames.Image"/> data is in WEBP format.</summary>
48110
public const string Webp = "image/webp";
49111
}
50112

113+
/// <summary>Specifies the kind of multipart data in an email message attachment.</summary>
51114
public static class Multipart
52115
{
116+
/// <summary>Specifies that the <see cref="MediaTypeNames.Multipart"/> data consists of multiple byte ranges.</summary>
53117
public const string ByteRanges = "multipart/byteranges";
118+
119+
/// <summary>Specifies that the <see cref="MediaTypeNames.Multipart"/> data is in form data format.</summary>
54120
public const string FormData = "multipart/form-data";
55121
}
56122

123+
/// <summary>Specifies the kind of text data in an email message attachment.</summary>
57124
public static class Text
58125
{
126+
/// <summary>Specifies that the <see cref="MediaTypeNames.Text"/> data is in CSS format.</summary>
59127
public const string Css = "text/css";
128+
129+
/// <summary>Specifies that the <see cref="MediaTypeNames.Text"/> data is in CSV format.</summary>
60130
public const string Csv = "text/csv";
131+
132+
/// <summary>Specifies that the <see cref="MediaTypeNames.Text"/> data is in HTML format.</summary>
61133
public const string Html = "text/html";
134+
135+
/// <summary>Specifies that the <see cref="MediaTypeNames.Text"/> data is in JavaScript format.</summary>
62136
public const string JavaScript = "text/javascript";
137+
138+
/// <summary>Specifies that the <see cref="MediaTypeNames.Text"/> data is in Markdown format.</summary>
63139
public const string Markdown = "text/markdown";
140+
141+
/// <summary>Specifies that the <see cref="MediaTypeNames.Text"/> data is in plain text format.</summary>
64142
public const string Plain = "text/plain";
143+
144+
/// <summary>Specifies that the <see cref="MediaTypeNames.Text"/> data is in Rich Text Format (RTF).</summary>
65145
public const string RichText = "text/richtext";
146+
147+
/// <summary>Specifies that the <see cref="MediaTypeNames.Text"/> data is in Rich Text Format (RTF).</summary>
66148
public const string Rtf = "text/rtf";
149+
150+
/// <summary>Specifies that the <see cref="MediaTypeNames.Text"/> data is in XML format.</summary>
67151
public const string Xml = "text/xml";
68152
}
69153
}

0 commit comments

Comments
 (0)