Document public macros.

Undocumented public macros emit warnings in nightly-2019-01-11,
and we #![deny] that warning.
This commit is contained in:
Simon Sapin 2019-01-11 14:03:44 +01:00
parent 9b98beb769
commit 3a710f22ed
2 changed files with 17 additions and 2 deletions

View file

@ -3821,7 +3821,14 @@ impl AliasId {
}
}
// NOTE(emilio): Callers are responsible to deal with prefs.
/// Call the given macro with tokens like this for each longhand and shorthand properties
/// that is enabled in content:
///
/// ```
/// [CamelCaseName, SetCamelCaseName, PropertyId::Longhand(LonghandId::CamelCaseName)],
/// ```
///
/// NOTE(emilio): Callers are responsible to deal with prefs.
#[macro_export]
macro_rules! css_properties_accessors {
($macro_name: ident) => {
@ -3844,6 +3851,14 @@ macro_rules! css_properties_accessors {
}
}
/// Call the given macro with tokens like this for each longhand properties:
///
/// ```
/// { snake_case_ident, true }
/// ```
///
/// … where the boolean indicates whether the property value type
/// is wrapped in a `Box<_>` in the corresponding `PropertyDeclaration` variant.
#[macro_export]
macro_rules! longhand_properties_idents {
($macro_name: ident) => {

View file

@ -432,7 +432,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);
#[macro_export]
/// Define an enum type with unit variants that each corrsepond to a CSS keyword.
macro_rules! define_css_keyword_enum {
(pub enum $name:ident { $($variant:ident = $css:expr,)+ }) => {
#[allow(missing_docs)]