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

@ -230,10 +230,10 @@ pub struct CallSetup {
old_compartment: *mut JSCompartment,
/// The exception handling used for the call.
handling: ExceptionHandling,
/// https://heycam.github.io/webidl/#es-invoking-callback-functions
/// <https://heycam.github.io/webidl/#es-invoking-callback-functions>
/// steps 8 and 18.2.
entry_script: Option<AutoEntryScript>,
/// https://heycam.github.io/webidl/#es-invoking-callback-functions
/// <https://heycam.github.io/webidl/#es-invoking-callback-functions>
/// steps 9 and 18.1.
incumbent_script: Option<AutoIncumbentScript>,
}

View file

@ -6,31 +6,31 @@
//!
//! | IDL type | Argument type | Return type |
//! |-------------------------|-----------------|----------------|
//! | any | `JSVal` |
//! | boolean | `bool` |
//! | byte | `i8` |
//! | octet | `u8` |
//! | short | `i16` |
//! | unsigned short | `u16` |
//! | long | `i32` |
//! | unsigned long | `u32` |
//! | long long | `i64` |
//! | unsigned long long | `u64` |
//! | unrestricted float | `f32` |
//! | float | `Finite<f32>` |
//! | unrestricted double | `f64` |
//! | double | `Finite<f64>` |
//! | DOMString | `DOMString` |
//! | USVString | `USVString` |
//! | ByteString | `ByteString` |
//! | object | `*mut JSObject` |
//! | any | `JSVal` | |
//! | boolean | `bool` | |
//! | byte | `i8` | |
//! | octet | `u8` | |
//! | short | `i16` | |
//! | unsigned short | `u16` | |
//! | long | `i32` | |
//! | unsigned long | `u32` | |
//! | long long | `i64` | |
//! | unsigned long long | `u64` | |
//! | unrestricted float | `f32` | |
//! | float | `Finite<f32>` | |
//! | unrestricted double | `f64` | |
//! | double | `Finite<f64>` | |
//! | DOMString | `DOMString` | |
//! | USVString | `USVString` | |
//! | ByteString | `ByteString` | |
//! | object | `*mut JSObject` | |
//! | interface types | `&T` | `DomRoot<T>` |
//! | dictionary types | `&T` | *unsupported* |
//! | enumeration types | `T` |
//! | callback function types | `Rc<T>` |
//! | nullable types | `Option<T>` |
//! | sequences | `Vec<T>` |
//! | union types | `T` |
//! | enumeration types | `T` | |
//! | callback function types | `Rc<T>` | |
//! | nullable types | `Option<T>` | |
//! | sequences | `Vec<T>` | |
//! | union types | `T` | |
use dom::bindings::error::{Error, Fallible};
use dom::bindings::inheritance::Castable;

View file

@ -548,7 +548,7 @@ unsafe extern "C" fn has_instance_hook(cx: *mut JSContext,
}
/// Return whether a value is an instance of a given prototype.
/// http://heycam.github.io/webidl/#es-interface-hasinstance
/// <http://heycam.github.io/webidl/#es-interface-hasinstance>
unsafe fn has_instance(
cx: *mut JSContext,
interface_object: HandleObject,

View file

@ -712,7 +712,7 @@ impl<T: DomObject> LayoutDom<T> {
}
}
/// Helper trait for safer manipulations of Option<Heap<T>> values.
/// Helper trait for safer manipulations of `Option<Heap<T>>` values.
pub trait OptionalHeapSetter {
type Value;
/// Update this optional heap value with a new value.

View file

@ -41,7 +41,7 @@ pub struct AutoEntryScript {
}
impl AutoEntryScript {
/// https://html.spec.whatwg.org/multipage/#prepare-to-run-script
/// <https://html.spec.whatwg.org/multipage/#prepare-to-run-script>
pub fn new(global: &GlobalScope) -> Self {
STACK.with(|stack| {
trace!("Prepare to run script with {:p}", global);
@ -58,7 +58,7 @@ impl AutoEntryScript {
}
impl Drop for AutoEntryScript {
/// https://html.spec.whatwg.org/multipage/#clean-up-after-running-script
/// <https://html.spec.whatwg.org/multipage/#clean-up-after-running-script>
fn drop(&mut self) {
STACK.with(|stack| {
let mut stack = stack.borrow_mut();
@ -96,7 +96,7 @@ pub struct AutoIncumbentScript {
}
impl AutoIncumbentScript {
/// https://html.spec.whatwg.org/multipage/#prepare-to-run-a-callback
/// <https://html.spec.whatwg.org/multipage/#prepare-to-run-a-callback>
pub fn new(global: &GlobalScope) -> Self {
// Step 2-3.
unsafe {
@ -120,7 +120,7 @@ impl AutoIncumbentScript {
}
impl Drop for AutoIncumbentScript {
/// https://html.spec.whatwg.org/multipage/#clean-up-after-running-a-callback
/// <https://html.spec.whatwg.org/multipage/#clean-up-after-running-a-callback>
fn drop(&mut self) {
STACK.with(|stack| {
// Step 4.

View file

@ -194,7 +194,7 @@ pub unsafe fn find_enum_value<'a, T>(cx: *mut JSContext,
}
/// Returns wether `obj` is a platform object
/// https://heycam.github.io/webidl/#dfn-platform-object
/// <https://heycam.github.io/webidl/#dfn-platform-object>
pub fn is_platform_object(obj: *mut JSObject) -> bool {
unsafe {
// Fast-path the common case