Skip to content

Commit 9cbf549

Browse files
seanmonstarseanmonstar
committed
Merge pull request #674 from pyfisch/doccomments
style(headers): use regular doc-comments inside macros
2 parents d16ef6d + 4c756a9 commit 9cbf549

33 files changed

+1209
-1209
lines changed

Diff for: ‎src/header/common/accept.rs

+73-73
Original file line numberDiff line numberDiff line change
@@ -3,79 +3,79 @@ use mime::Mime;
33
use header::QualityItem;
44

55
header! {
6-
#[doc="`Accept` header, defined in [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.2)"]
7-
#[doc=""]
8-
#[doc="The `Accept` header field can be used by user agents to specify"]
9-
#[doc="response media types that are acceptable. Accept header fields can"]
10-
#[doc="be used to indicate that the request is specifically limited to a"]
11-
#[doc="small set of desired types, as in the case of a request for an"]
12-
#[doc="in-line image"]
13-
#[doc=""]
14-
#[doc="# ABNF"]
15-
#[doc="```plain"]
16-
#[doc="Accept = #( media-range [ accept-params ] )"]
17-
#[doc=""]
18-
#[doc="media-range = ( \"*/*\""]
19-
#[doc=" / ( type \"/\" \"*\" )"]
20-
#[doc=" / ( type \"/\" subtype )"]
21-
#[doc=" ) *( OWS \";\" OWS parameter )"]
22-
#[doc="accept-params = weight *( accept-ext )"]
23-
#[doc="accept-ext = OWS \";\" OWS token [ \"=\" ( token / quoted-string ) ]"]
24-
#[doc="```"]
25-
#[doc=""]
26-
#[doc="# Example values"]
27-
#[doc="* `audio/*; q=0.2, audio/basic` (`*` value won't parse correctly)"]
28-
#[doc="* `text/plain; q=0.5, text/html, text/x-dvi; q=0.8, text/x-c`"]
29-
#[doc=""]
30-
#[doc="# Examples"]
31-
#[doc="```"]
32-
#[doc="use hyper::header::{Headers, Accept, qitem};"]
33-
#[doc="use hyper::mime::{Mime, TopLevel, SubLevel};"]
34-
#[doc=""]
35-
#[doc="let mut headers = Headers::new();"]
36-
#[doc=""]
37-
#[doc="headers.set("]
38-
#[doc=" Accept(vec!["]
39-
#[doc=" qitem(Mime(TopLevel::Text, SubLevel::Html, vec![])),"]
40-
#[doc=" ])"]
41-
#[doc=");"]
42-
#[doc="```"]
43-
#[doc="```"]
44-
#[doc="use hyper::header::{Headers, Accept, qitem};"]
45-
#[doc="use hyper::mime::{Mime, TopLevel, SubLevel, Attr, Value};"]
46-
#[doc=""]
47-
#[doc="let mut headers = Headers::new();"]
48-
#[doc="headers.set("]
49-
#[doc=" Accept(vec!["]
50-
#[doc=" qitem(Mime(TopLevel::Application, SubLevel::Json,"]
51-
#[doc=" vec![(Attr::Charset, Value::Utf8)])),"]
52-
#[doc=" ])"]
53-
#[doc=");"]
54-
#[doc="```"]
55-
#[doc="```"]
56-
#[doc="use hyper::header::{Headers, Accept, QualityItem, Quality, qitem};"]
57-
#[doc="use hyper::mime::{Mime, TopLevel, SubLevel};"]
58-
#[doc=""]
59-
#[doc="let mut headers = Headers::new();"]
60-
#[doc=""]
61-
#[doc="headers.set("]
62-
#[doc=" Accept(vec!["]
63-
#[doc=" qitem(Mime(TopLevel::Text, SubLevel::Html, vec![])),"]
64-
#[doc=" qitem(Mime(TopLevel::Application,"]
65-
#[doc=" SubLevel::Ext(\"xhtml+xml\".to_owned()), vec![])),"]
66-
#[doc=" QualityItem::new(Mime(TopLevel::Application, SubLevel::Xml, vec![]),"]
67-
#[doc=" Quality(900)),"]
68-
#[doc=" qitem(Mime(TopLevel::Image,"]
69-
#[doc=" SubLevel::Ext(\"webp\".to_owned()), vec![])),"]
70-
#[doc=" QualityItem::new(Mime(TopLevel::Star, SubLevel::Star, vec![]),"]
71-
#[doc=" Quality(800))"]
72-
#[doc=" ])"]
73-
#[doc=");"]
74-
#[doc="```"]
75-
#[doc=""]
76-
#[doc="# Notes"]
77-
#[doc="* Using always Mime types to represent `media-range` differs from the ABNF."]
78-
#[doc="* **FIXME**: `accept-ext` is not supported."]
6+
/// `Accept` header, defined in [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.2)
7+
///
8+
/// The `Accept` header field can be used by user agents to specify
9+
/// response media types that are acceptable. Accept header fields can
10+
/// be used to indicate that the request is specifically limited to a
11+
/// small set of desired types, as in the case of a request for an
12+
/// in-line image
13+
///
14+
/// # ABNF
15+
/// ```plain
16+
/// Accept = #( media-range [ accept-params ] )
17+
///
18+
/// media-range = ( "*/*"
19+
/// / ( type "/" "*" )
20+
/// / ( type "/" subtype )
21+
/// ) *( OWS ";" OWS parameter )
22+
/// accept-params = weight *( accept-ext )
23+
/// accept-ext = OWS ";" OWS token [ "=" ( token / quoted-string ) ]
24+
/// ```
25+
///
26+
/// # Example values
27+
/// * `audio/*; q=0.2, audio/basic` (`*` value won't parse correctly)
28+
/// * `text/plain; q=0.5, text/html, text/x-dvi; q=0.8, text/x-c`
29+
///
30+
/// # Examples
31+
/// ```
32+
/// use hyper::header::{Headers, Accept, qitem};
33+
/// use hyper::mime::{Mime, TopLevel, SubLevel};
34+
///
35+
/// let mut headers = Headers::new();
36+
///
37+
/// headers.set(
38+
/// Accept(vec![
39+
/// qitem(Mime(TopLevel::Text, SubLevel::Html, vec![])),
40+
/// ])
41+
/// );
42+
/// ```
43+
/// ```
44+
/// use hyper::header::{Headers, Accept, qitem};
45+
/// use hyper::mime::{Mime, TopLevel, SubLevel, Attr, Value};
46+
///
47+
/// let mut headers = Headers::new();
48+
/// headers.set(
49+
/// Accept(vec![
50+
/// qitem(Mime(TopLevel::Application, SubLevel::Json,
51+
/// vec![(Attr::Charset, Value::Utf8)])),
52+
/// ])
53+
/// );
54+
/// ```
55+
/// ```
56+
/// use hyper::header::{Headers, Accept, QualityItem, Quality, qitem};
57+
/// use hyper::mime::{Mime, TopLevel, SubLevel};
58+
///
59+
/// let mut headers = Headers::new();
60+
///
61+
/// headers.set(
62+
/// Accept(vec![
63+
/// qitem(Mime(TopLevel::Text, SubLevel::Html, vec![])),
64+
/// qitem(Mime(TopLevel::Application,
65+
/// SubLevel::Ext("xhtml+xml".to_owned()), vec![])),
66+
/// QualityItem::new(Mime(TopLevel::Application, SubLevel::Xml, vec![]),
67+
/// Quality(900)),
68+
/// qitem(Mime(TopLevel::Image,
69+
/// SubLevel::Ext("webp".to_owned()), vec![])),
70+
/// QualityItem::new(Mime(TopLevel::Star, SubLevel::Star, vec![]),
71+
/// Quality(800))
72+
/// ])
73+
/// );
74+
/// ```
75+
///
76+
/// # Notes
77+
/// * Using always Mime types to represent `media-range` differs from the ABNF.
78+
/// * **FIXME**: `accept-ext` is not supported.
7979
(Accept, "Accept") => (QualityItem<Mime>)+
8080

8181
test_accept {

Diff for: ‎src/header/common/accept_charset.rs

+46-46
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,52 @@
11
use header::{Charset, QualityItem};
22

33
header! {
4-
#[doc="`Accept-Charset` header, defined in"]
5-
#[doc="[RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.3)"]
6-
#[doc=""]
7-
#[doc="The `Accept-Charset` header field can be sent by a user agent to"]
8-
#[doc="indicate what charsets are acceptable in textual response content."]
9-
#[doc="This field allows user agents capable of understanding more"]
10-
#[doc="comprehensive or special-purpose charsets to signal that capability"]
11-
#[doc="to an origin server that is capable of representing information in"]
12-
#[doc="those charsets."]
13-
#[doc=""]
14-
#[doc="# ABNF"]
15-
#[doc="```plain"]
16-
#[doc="Accept-Charset = 1#( ( charset / \"*\" ) [ weight ] )"]
17-
#[doc="```"]
18-
#[doc=""]
19-
#[doc="# Example values"]
20-
#[doc="* `iso-8859-5, unicode-1-1;q=0.8`"]
21-
#[doc=""]
22-
#[doc="# Examples"]
23-
#[doc="```"]
24-
#[doc="use hyper::header::{Headers, AcceptCharset, Charset, qitem};"]
25-
#[doc=""]
26-
#[doc="let mut headers = Headers::new();"]
27-
#[doc="headers.set("]
28-
#[doc=" AcceptCharset(vec![qitem(Charset::Us_Ascii)])"]
29-
#[doc=");"]
30-
#[doc="```"]
31-
#[doc="```"]
32-
#[doc="use hyper::header::{Headers, AcceptCharset, Charset, Quality, QualityItem};"]
33-
#[doc=""]
34-
#[doc="let mut headers = Headers::new();"]
35-
#[doc="headers.set("]
36-
#[doc=" AcceptCharset(vec!["]
37-
#[doc=" QualityItem::new(Charset::Us_Ascii, Quality(900)),"]
38-
#[doc=" QualityItem::new(Charset::Iso_8859_10, Quality(200)),"]
39-
#[doc=" ])"]
40-
#[doc=");"]
41-
#[doc="```"]
42-
#[doc="```"]
43-
#[doc="use hyper::header::{Headers, AcceptCharset, Charset, qitem};"]
44-
#[doc=""]
45-
#[doc="let mut headers = Headers::new();"]
46-
#[doc="headers.set("]
47-
#[doc=" AcceptCharset(vec![qitem(Charset::Ext(\"utf-8\".to_owned()))])"]
48-
#[doc=");"]
49-
#[doc="```"]
4+
/// `Accept-Charset` header, defined in
5+
/// [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.3)
6+
///
7+
/// The `Accept-Charset` header field can be sent by a user agent to
8+
/// indicate what charsets are acceptable in textual response content.
9+
/// This field allows user agents capable of understanding more
10+
/// comprehensive or special-purpose charsets to signal that capability
11+
/// to an origin server that is capable of representing information in
12+
/// those charsets.
13+
///
14+
/// # ABNF
15+
/// ```plain
16+
/// Accept-Charset = 1#( ( charset / "*" ) [ weight ] )
17+
/// ```
18+
///
19+
/// # Example values
20+
/// * `iso-8859-5, unicode-1-1;q=0.8`
21+
///
22+
/// # Examples
23+
/// ```
24+
/// use hyper::header::{Headers, AcceptCharset, Charset, qitem};
25+
///
26+
/// let mut headers = Headers::new();
27+
/// headers.set(
28+
/// AcceptCharset(vec![qitem(Charset::Us_Ascii)])
29+
/// );
30+
/// ```
31+
/// ```
32+
/// use hyper::header::{Headers, AcceptCharset, Charset, Quality, QualityItem};
33+
///
34+
/// let mut headers = Headers::new();
35+
/// headers.set(
36+
/// AcceptCharset(vec![
37+
/// QualityItem::new(Charset::Us_Ascii, Quality(900)),
38+
/// QualityItem::new(Charset::Iso_8859_10, Quality(200)),
39+
/// ])
40+
/// );
41+
/// ```
42+
/// ```
43+
/// use hyper::header::{Headers, AcceptCharset, Charset, qitem};
44+
///
45+
/// let mut headers = Headers::new();
46+
/// headers.set(
47+
/// AcceptCharset(vec![qitem(Charset::Ext("utf-8".to_owned()))])
48+
/// );
49+
/// ```
5050
(AcceptCharset, "Accept-Charset") => (QualityItem<Charset>)+
5151

5252
test_accept_charset {

Diff for: ‎src/header/common/accept_encoding.rs

+55-55
Original file line numberDiff line numberDiff line change
@@ -1,61 +1,61 @@
11
use header::{Encoding, QualityItem};
22

33
header! {
4-
#[doc="`Accept-Encoding` header, defined in"]
5-
#[doc="[RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.4)"]
6-
#[doc=""]
7-
#[doc="The `Accept-Encoding` header field can be used by user agents to"]
8-
#[doc="indicate what response content-codings are"]
9-
#[doc="acceptable in the response. An `identity` token is used as a synonym"]
10-
#[doc="for \"no encoding\" in order to communicate when no encoding is"]
11-
#[doc="preferred."]
12-
#[doc=""]
13-
#[doc="# ABNF"]
14-
#[doc="```plain"]
15-
#[doc="Accept-Encoding = #( codings [ weight ] )"]
16-
#[doc="codings = content-coding / \"identity\" / \"*\""]
17-
#[doc="```"]
18-
#[doc=""]
19-
#[doc="# Example values"]
20-
#[doc="* `compress, gzip`"]
21-
#[doc="* ``"]
22-
#[doc="* `*`"]
23-
#[doc="* `compress;q=0.5, gzip;q=1`"]
24-
#[doc="* `gzip;q=1.0, identity; q=0.5, *;q=0`"]
25-
#[doc=""]
26-
#[doc="# Examples"]
27-
#[doc="```"]
28-
#[doc="use hyper::header::{Headers, AcceptEncoding, Encoding, qitem};"]
29-
#[doc=""]
30-
#[doc="let mut headers = Headers::new();"]
31-
#[doc="headers.set("]
32-
#[doc=" AcceptEncoding(vec![qitem(Encoding::Chunked)])"]
33-
#[doc=");"]
34-
#[doc="```"]
35-
#[doc="```"]
36-
#[doc="use hyper::header::{Headers, AcceptEncoding, Encoding, qitem};"]
37-
#[doc=" "]
38-
#[doc="let mut headers = Headers::new();"]
39-
#[doc="headers.set("]
40-
#[doc=" AcceptEncoding(vec!["]
41-
#[doc=" qitem(Encoding::Chunked),"]
42-
#[doc=" qitem(Encoding::Gzip),"]
43-
#[doc=" qitem(Encoding::Deflate),"]
44-
#[doc=" ])"]
45-
#[doc=");"]
46-
#[doc="```"]
47-
#[doc="```"]
48-
#[doc="use hyper::header::{Headers, AcceptEncoding, Encoding, QualityItem, Quality, qitem};"]
49-
#[doc=" "]
50-
#[doc="let mut headers = Headers::new();"]
51-
#[doc="headers.set("]
52-
#[doc=" AcceptEncoding(vec!["]
53-
#[doc=" qitem(Encoding::Chunked),"]
54-
#[doc=" QualityItem::new(Encoding::Gzip, Quality(600)),"]
55-
#[doc=" QualityItem::new(Encoding::EncodingExt(\"*\".to_owned()), Quality(0)),"]
56-
#[doc=" ])"]
57-
#[doc=");"]
58-
#[doc="```"]
4+
/// `Accept-Encoding` header, defined in
5+
/// [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.3.4)
6+
///
7+
/// The `Accept-Encoding` header field can be used by user agents to
8+
/// indicate what response content-codings are
9+
/// acceptable in the response. An `identity` token is used as a synonym
10+
/// for "no encoding" in order to communicate when no encoding is
11+
/// preferred.
12+
///
13+
/// # ABNF
14+
/// ```plain
15+
/// Accept-Encoding = #( codings [ weight ] )
16+
/// codings = content-coding / "identity" / "*"
17+
/// ```
18+
///
19+
/// # Example values
20+
/// * `compress, gzip`
21+
/// * ``
22+
/// * `*`
23+
/// * `compress;q=0.5, gzip;q=1`
24+
/// * `gzip;q=1.0, identity; q=0.5, *;q=0`
25+
///
26+
/// # Examples
27+
/// ```
28+
/// use hyper::header::{Headers, AcceptEncoding, Encoding, qitem};
29+
///
30+
/// let mut headers = Headers::new();
31+
/// headers.set(
32+
/// AcceptEncoding(vec![qitem(Encoding::Chunked)])
33+
/// );
34+
/// ```
35+
/// ```
36+
/// use hyper::header::{Headers, AcceptEncoding, Encoding, qitem};
37+
///
38+
/// let mut headers = Headers::new();
39+
/// headers.set(
40+
/// AcceptEncoding(vec![
41+
/// qitem(Encoding::Chunked),
42+
/// qitem(Encoding::Gzip),
43+
/// qitem(Encoding::Deflate),
44+
/// ])
45+
/// );
46+
/// ```
47+
/// ```
48+
/// use hyper::header::{Headers, AcceptEncoding, Encoding, QualityItem, Quality, qitem};
49+
///
50+
/// let mut headers = Headers::new();
51+
/// headers.set(
52+
/// AcceptEncoding(vec![
53+
/// qitem(Encoding::Chunked),
54+
/// QualityItem::new(Encoding::Gzip, Quality(600)),
55+
/// QualityItem::new(Encoding::EncodingExt("*".to_owned()), Quality(0)),
56+
/// ])
57+
/// );
58+
/// ```
5959
(AcceptEncoding, "Accept-Encoding") => (QualityItem<Encoding>)*
6060

6161
test_accept_encoding {

0 commit comments

Comments
 (0)