Fix commonmark Markdown warnings in docs, part 1

Fixes warnings from rust-lang/rust#44229 when `--enable-commonmark` is
passed to rustdoc.

This is mostly a global find-and-replace for bare URIs on lines by
themselves in doc comments.
This commit is contained in:
Matt Brubeck 2017-10-17 09:39:20 -07:00
parent aa3122e7d1
commit efc3683cc7
137 changed files with 572 additions and 565 deletions

View file

@ -15,7 +15,7 @@ macro_rules! define_cursor {
$( $g_css: expr => $g_variant: ident = $g_value: expr, )+
]
) => {
/// https://drafts.csswg.org/css-ui/#cursor
/// <https://drafts.csswg.org/css-ui/#cursor>
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
#[cfg_attr(feature = "gecko", derive(MallocSizeOf))]
#[cfg_attr(feature = "servo", derive(Deserialize, Serialize, HeapSizeOf))]

View file

@ -57,7 +57,7 @@ impl PinchZoomFactor {
}
/// One CSS "px" in the coordinate system of the "initial viewport":
/// http://www.w3.org/TR/css-device-adapt/#initial-viewport
/// <http://www.w3.org/TR/css-device-adapt/#initial-viewport>
///
/// `CSSPixel` is equal to `DeviceIndependentPixel` times a "page zoom" factor controlled by the user. This is
/// the desktop-style "full page" zoom that enlarges content but then reflows the layout viewport
@ -201,14 +201,14 @@ bitflags! {
/// The mode to use when parsing values.
pub flags ParsingMode: u8 {
/// In CSS, lengths must have units, except for zero values, where the unit can be omitted.
/// https://www.w3.org/TR/css3-values/#lengths
/// <https://www.w3.org/TR/css3-values/#lengths>
const PARSING_MODE_DEFAULT = 0x00,
/// In SVG, a coordinate or length value without a unit identifier (e.g., "25") is assumed
/// to be in user units (px).
/// https://www.w3.org/TR/SVG/coords.html#Units
/// <https://www.w3.org/TR/SVG/coords.html#Units>
const PARSING_MODE_ALLOW_UNITLESS_LENGTH = 0x01,
/// In SVG, out-of-range values are not treated as an error in parsing.
/// https://www.w3.org/TR/SVG/implnote.html#RangeClamping
/// <https://www.w3.org/TR/SVG/implnote.html#RangeClamping>
const PARSING_MODE_ALLOW_ALL_NUMERIC_VALUES = 0x02,
}
}
@ -228,6 +228,6 @@ impl ParsingMode {
#[cfg(feature = "servo")]
/// Speculatively execute paint code in the worklet thread pool.
pub trait SpeculativePainter: Send + Sync {
/// https://drafts.css-houdini.org/css-paint-api/#draw-a-paint-image
/// <https://drafts.css-houdini.org/css-paint-api/#draw-a-paint-image>
fn speculatively_draw_a_paint_image(&self, properties: Vec<(Atom, String)>, arguments: Vec<String>);
}

View file

@ -21,7 +21,7 @@ define_css_keyword_enum!(Orientation:
/// A set of viewport descriptors:
///
/// https://drafts.csswg.org/css-device-adapt/#viewport-desc
/// <https://drafts.csswg.org/css-device-adapt/#viewport-desc>
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(feature = "servo", derive(Deserialize, Serialize, HeapSizeOf))]
pub struct ViewportConstraints {
@ -29,15 +29,15 @@ pub struct ViewportConstraints {
/// * https://drafts.csswg.org/css-device-adapt/#width-desc
/// * https://drafts.csswg.org/css-device-adapt/#height-desc
pub size: TypedSize2D<f32, CSSPixel>,
/// https://drafts.csswg.org/css-device-adapt/#zoom-desc
/// <https://drafts.csswg.org/css-device-adapt/#zoom-desc>
pub initial_zoom: PinchZoomFactor,
/// https://drafts.csswg.org/css-device-adapt/#min-max-width-desc
/// <https://drafts.csswg.org/css-device-adapt/#min-max-width-desc>
pub min_zoom: Option<PinchZoomFactor>,
/// https://drafts.csswg.org/css-device-adapt/#min-max-width-desc
/// <https://drafts.csswg.org/css-device-adapt/#min-max-width-desc>
pub max_zoom: Option<PinchZoomFactor>,
/// https://drafts.csswg.org/css-device-adapt/#user-zoom-desc
/// <https://drafts.csswg.org/css-device-adapt/#user-zoom-desc>
pub user_zoom: UserZoom,
/// https://drafts.csswg.org/css-device-adapt/#orientation-desc
/// <https://drafts.csswg.org/css-device-adapt/#orientation-desc>
pub orientation: Orientation
}
@ -73,7 +73,7 @@ impl ToCss for ViewportConstraints {
}
}
/// https://drafts.csswg.org/css-device-adapt/#descdef-viewport-zoom
/// <https://drafts.csswg.org/css-device-adapt/#descdef-viewport-zoom>
#[derive(Clone, Copy, Debug, PartialEq)]
#[cfg_attr(feature = "servo", derive(HeapSizeOf))]
pub enum Zoom {
@ -103,7 +103,7 @@ impl ToCss for Zoom {
impl Zoom {
/// Parse a zoom value per:
///
/// https://drafts.csswg.org/css-device-adapt/#descdef-viewport-zoom
/// <https://drafts.csswg.org/css-device-adapt/#descdef-viewport-zoom>
pub fn parse<'i, 't>(input: &mut Parser<'i, 't>) -> Result<Zoom, ParseError<'i>> {
use PARSING_MODE_DEFAULT;
use cssparser::Token;