From cd33142e8b9eb65748aed03b8b206ab55496f43b Mon Sep 17 00:00:00 2001
From: Nicholas Nethercote <nnethercote@mozilla.com>
Date: Mon, 14 Jan 2019 14:58:39 +1100
Subject: [PATCH] Fix some "error: missing documentation for macro" errors.

The compiler must have got stricter about these recently.

This gets `futures`, `hyper`, and `style-servo` compiling again.
`script-servo` is still broken due to a different, trickier problem.
---
 collector/benchmarks/futures/src/poll.rs                     | 1 +
 collector/benchmarks/hyper/src/header/common/mod.rs          | 5 +++++
 .../components/style/properties/properties.mako.rs           | 2 ++
 .../script-servo/components/style_traits/values.rs           | 5 +++++
 .../components/style/gecko/generated/atom_macro.rs           | 1 +
 .../style-servo/components/style/gecko/regen_atoms.py        | 1 +
 .../components/style/gecko_string_cache/namespace.rs         | 1 +
 .../components/style/properties/properties.mako.rs           | 3 +++
 .../benchmarks/style-servo/components/style_traits/values.rs | 4 ++++
 9 files changed, 23 insertions(+)

diff --git a/collector/benchmarks/futures/src/poll.rs b/collector/benchmarks/futures/src/poll.rs
index 8d78839d5..ef17a1b04 100644
--- a/collector/benchmarks/futures/src/poll.rs
+++ b/collector/benchmarks/futures/src/poll.rs
@@ -1,4 +1,5 @@
 
+/// A macro.
 #[macro_export]
 macro_rules! try_poll {
     ($e:expr) => (match $e {
diff --git a/collector/benchmarks/hyper/src/header/common/mod.rs b/collector/benchmarks/hyper/src/header/common/mod.rs
index 5f93b854d..ba489ace5 100644
--- a/collector/benchmarks/hyper/src/header/common/mod.rs
+++ b/collector/benchmarks/hyper/src/header/common/mod.rs
@@ -48,6 +48,7 @@ pub use self::upgrade::{Upgrade, Protocol, ProtocolName};
 pub use self::user_agent::UserAgent;
 pub use self::vary::Vary;
 
+/// A macro.
 #[macro_export]
 macro_rules! bench_header(
     ($name:ident, $ty:ty, $value:expr) => {
@@ -79,6 +80,7 @@ macro_rules! bench_header(
     }
 );
 
+/// A macro.
 #[macro_export]
 macro_rules! __hyper__deref {
     ($from:ty => $to:ty) => {
@@ -98,6 +100,7 @@ macro_rules! __hyper__deref {
     }
 }
 
+/// A macro.
 #[macro_export]
 macro_rules! __hyper__tm {
     ($id:ident, $tm:ident{$($tf:item)*}) => {
@@ -114,6 +117,7 @@ macro_rules! __hyper__tm {
     }
 }
 
+/// A macro.
 #[macro_export]
 macro_rules! test_header {
     ($id:ident, $raw:expr) => {
@@ -154,6 +158,7 @@ macro_rules! test_header {
     }
 }
 
+/// A macro.
 #[macro_export]
 macro_rules! header {
     // $a:meta: Attributes associated with the header item (usually docs)
diff --git a/collector/benchmarks/script-servo/components/style/properties/properties.mako.rs b/collector/benchmarks/script-servo/components/style/properties/properties.mako.rs
index f59bb52b0..38677e273 100644
--- a/collector/benchmarks/script-servo/components/style/properties/properties.mako.rs
+++ b/collector/benchmarks/script-servo/components/style/properties/properties.mako.rs
@@ -3627,6 +3627,7 @@ impl AliasId {
     }
 }
 
+/// A macro.
 #[macro_export]
 macro_rules! css_properties_accessors {
     ($macro_name: ident) => {
@@ -3649,6 +3650,7 @@ macro_rules! css_properties_accessors {
     }
 }
 
+/// A macro.
 #[macro_export]
 macro_rules! longhand_properties_idents {
     ($macro_name: ident) => {
diff --git a/collector/benchmarks/script-servo/components/style_traits/values.rs b/collector/benchmarks/script-servo/components/style_traits/values.rs
index 9b2b308d5..a3418c2d0 100644
--- a/collector/benchmarks/script-servo/components/style_traits/values.rs
+++ b/collector/benchmarks/script-servo/components/style_traits/values.rs
@@ -71,6 +71,7 @@ where
     }
 }
 
+/// A macro.
 #[macro_export]
 macro_rules! serialize_function {
     ($dest: expr, $name: ident($( $arg: expr, )+)) => {
@@ -379,6 +380,7 @@ impl_to_css_for_predefined_type!(::cssparser::RGBA);
 impl_to_css_for_predefined_type!(::cssparser::Color);
 impl_to_css_for_predefined_type!(::cssparser::UnicodeRange);
 
+/// A macro.
 #[macro_export]
 macro_rules! define_css_keyword_enum {
     ($name: ident: values { $( $css: expr => $variant: ident),+, }
@@ -409,6 +411,7 @@ macro_rules! define_css_keyword_enum {
     };
 }
 
+/// A macro.
 #[cfg(feature = "servo")]
 #[macro_export]
 macro_rules! __define_css_keyword_enum__add_optional_traits {
@@ -422,6 +425,7 @@ macro_rules! __define_css_keyword_enum__add_optional_traits {
     };
 }
 
+/// A macro.
 #[cfg(not(feature = "servo"))]
 #[macro_export]
 macro_rules! __define_css_keyword_enum__add_optional_traits {
@@ -435,6 +439,7 @@ macro_rules! __define_css_keyword_enum__add_optional_traits {
     };
 }
 
+/// A macro.
 #[macro_export]
 macro_rules! __define_css_keyword_enum__actual {
     ($name: ident [ $( $derived_trait: ident),* ]
diff --git a/collector/benchmarks/style-servo/components/style/gecko/generated/atom_macro.rs b/collector/benchmarks/style-servo/components/style/gecko/generated/atom_macro.rs
index db43667f6..d42372619 100644
--- a/collector/benchmarks/style-servo/components/style/gecko/generated/atom_macro.rs
+++ b/collector/benchmarks/style-servo/components/style/gecko/generated/atom_macro.rs
@@ -15534,6 +15534,7 @@ cfg_if! {
     }
 }
 
+/// A macro.
 #[macro_export]
 macro_rules! atom {
 ("") =>
diff --git a/collector/benchmarks/style-servo/components/style/gecko/regen_atoms.py b/collector/benchmarks/style-servo/components/style/gecko/regen_atoms.py
index 7ee1ccab3..559ae8ddf 100755
--- a/collector/benchmarks/style-servo/components/style/gecko/regen_atoms.py
+++ b/collector/benchmarks/style-servo/components/style/gecko/regen_atoms.py
@@ -202,6 +202,7 @@ def __exit__(self, type, value, traceback):
                  ' }};')
 
 MACRO = '''
+/// A macro.
 #[macro_export]
 macro_rules! atom {{
 {}
diff --git a/collector/benchmarks/style-servo/components/style/gecko_string_cache/namespace.rs b/collector/benchmarks/style-servo/components/style/gecko_string_cache/namespace.rs
index 92288574e..cce54551c 100644
--- a/collector/benchmarks/style-servo/components/style/gecko_string_cache/namespace.rs
+++ b/collector/benchmarks/style-servo/components/style/gecko_string_cache/namespace.rs
@@ -11,6 +11,7 @@ use std::fmt;
 use std::ops::Deref;
 use string_cache::{Atom, WeakAtom};
 
+/// A macro.
 #[macro_export]
 macro_rules! ns {
     () => { $crate::string_cache::Namespace(atom!("")) };
diff --git a/collector/benchmarks/style-servo/components/style/properties/properties.mako.rs b/collector/benchmarks/style-servo/components/style/properties/properties.mako.rs
index de736e7dd..975aba26a 100644
--- a/collector/benchmarks/style-servo/components/style/properties/properties.mako.rs
+++ b/collector/benchmarks/style-servo/components/style/properties/properties.mako.rs
@@ -50,6 +50,7 @@ use style_adjuster::StyleAdjuster;
 
 pub use self::declaration_block::*;
 
+/// A macro.
 #[cfg(feature = "gecko")]
 #[macro_export]
 macro_rules! property_name {
@@ -3593,6 +3594,7 @@ impl AliasId {
     }
 }
 
+/// A macro.
 #[macro_export]
 macro_rules! css_properties_accessors {
     ($macro_name: ident) => {
@@ -3615,6 +3617,7 @@ macro_rules! css_properties_accessors {
     }
 }
 
+/// A macro.
 #[macro_export]
 macro_rules! longhand_properties_idents {
     ($macro_name: ident) => {
diff --git a/collector/benchmarks/style-servo/components/style_traits/values.rs b/collector/benchmarks/style-servo/components/style_traits/values.rs
index 7bd44501b..831f56e99 100644
--- a/collector/benchmarks/style-servo/components/style_traits/values.rs
+++ b/collector/benchmarks/style-servo/components/style_traits/values.rs
@@ -71,6 +71,7 @@ where
     }
 }
 
+/// A macro.
 #[macro_export]
 macro_rules! serialize_function {
     ($dest: expr, $name: ident($( $arg: expr, )+)) => {
@@ -379,6 +380,7 @@ impl_to_css_for_predefined_type!(::cssparser::RGBA);
 impl_to_css_for_predefined_type!(::cssparser::Color);
 impl_to_css_for_predefined_type!(::cssparser::UnicodeRange);
 
+/// A macro.
 #[macro_export]
 macro_rules! define_css_keyword_enum {
     ($name: ident: values { $( $css: expr => $variant: ident),+, }
@@ -422,6 +424,7 @@ macro_rules! __define_css_keyword_enum__add_optional_traits {
     };
 }
 
+/// A macro.
 #[cfg(not(feature = "servo"))]
 #[macro_export]
 macro_rules! __define_css_keyword_enum__add_optional_traits {
@@ -435,6 +438,7 @@ macro_rules! __define_css_keyword_enum__add_optional_traits {
     };
 }
 
+/// A macro.
 #[macro_export]
 macro_rules! __define_css_keyword_enum__actual {
     ($name: ident [ $( $derived_trait: ident),* ]