forked/hyper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

style(headers): use regular doc-comments inside macros

Browse Source 
A bug (rust-lang/rust#23812) in rustc prevented the use of normal
comments inside macros but this has been fixed.
This commit is contained in:
Pyfisch
2015-10-27 19:19:05 +01:00
parent d16ef6d9d4
commit 4c756a9304
33 changed files with 1209 additions and 1209 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
src/header/common/referer.rs
View File

@@ -1,34 +1,34 @@
header! {
#[doc="`Referer` header, defined in"]
#[doc="[RFC7231](http://tools.ietf.org/html/rfc7231#section-5.5.2)"]
#[doc=""]
#[doc="The `Referer` [sic] header field allows the user agent to specify a"]
#[doc="URI reference for the resource from which the target URI was obtained"]
#[doc="(i.e., the \"referrer\", though the field name is misspelled). A user"]
#[doc="agent MUST NOT include the fragment and userinfo components of the"]
#[doc="URI reference, if any, when generating the Referer field value."]
#[doc=""]
#[doc="# ABNF"]
#[doc="```plain"]
#[doc="Referer = absolute-URI / partial-URI"]
#[doc="```"]
#[doc=""]
#[doc="# Example values"]
#[doc="* `http://www.example.org/hypertext/Overview.html`"]
#[doc=""]
#[doc="# Examples"]
#[doc="```"]
#[doc="use hyper::header::{Headers, Referer};"]
#[doc=""]
#[doc="let mut headers = Headers::new();"]
#[doc="headers.set(Referer(\"/People.html#tim\".to_owned()));"]
#[doc="```"]
#[doc="```"]
#[doc="use hyper::header::{Headers, Referer};"]
#[doc=""]
#[doc="let mut headers = Headers::new();"]
#[doc="headers.set(Referer(\"http://www.example.com/index.html\".to_owned()));"]
#[doc="```"]
/// `Referer` header, defined in
/// [RFC7231](http://tools.ietf.org/html/rfc7231#section-5.5.2)
///
/// The `Referer` [sic] header field allows the user agent to specify a
/// URI reference for the resource from which the target URI was obtained
/// (i.e., the "referrer", though the field name is misspelled). A user
/// agent MUST NOT include the fragment and userinfo components of the
/// URI reference, if any, when generating the Referer field value.
///
/// # ABNF
/// ```plain
/// Referer = absolute-URI / partial-URI
/// ```
///
/// # Example values
/// * `http://www.example.org/hypertext/Overview.html`
///
/// # Examples
/// ```
/// use hyper::header::{Headers, Referer};
///
/// let mut headers = Headers::new();
/// headers.set(Referer("/People.html#tim".to_owned()));
/// ```
/// ```
/// use hyper::header::{Headers, Referer};
///
/// let mut headers = Headers::new();
/// headers.set(Referer("http://www.example.com/index.html".to_owned()));
/// ```
// TODO Use URL
(Referer, "Referer") => [String]