Indicate items in doc comments as code-like.

This commit is contained in:
Corey Farwell 2016-11-08 09:33:03 -05:00
parent 085c52dfbc
commit 531289ebb7
5 changed files with 13 additions and 13 deletions

View file

@ -124,8 +124,8 @@ pub enum LayoutControlMsg {
GetWebFontLoadState(IpcSender<bool>),
}
/// Similar to net::resource_thread::LoadData
/// can be passed to LoadUrl to load a page with GET/POST
/// Similar to `net::resource_thread::LoadData`
/// can be passed to `LoadUrl` to load a page with GET/POST
/// parameters or headers
#[derive(Clone, Deserialize, Serialize)]
pub struct LoadData {
@ -364,7 +364,7 @@ pub enum CompositorEvent {
KeyEvent(Option<char>, Key, KeyState, KeyModifiers),
}
/// Touchpad pressure phase for TouchpadPressureEvent.
/// Touchpad pressure phase for `TouchpadPressureEvent`.
#[derive(Copy, Clone, HeapSizeOf, PartialEq, Deserialize, Serialize)]
pub enum TouchpadPressurePhase {
/// Pressure before a regular click.
@ -383,8 +383,8 @@ pub struct TimerEventRequest(pub IpcSender<TimerEvent>,
pub MsDuration);
/// Notifies the script thread to fire due timers.
/// TimerSource must be FromWindow when dispatched to ScriptThread and
/// must be FromWorker when dispatched to a DedicatedGlobalWorkerScope
/// `TimerSource` must be `FromWindow` when dispatched to `ScriptThread` and
/// must be `FromWorker` when dispatched to a `DedicatedGlobalWorkerScope`
#[derive(Deserialize, Serialize)]
pub struct TimerEvent(pub TimerSource, pub TimerEventId);
@ -397,7 +397,7 @@ pub enum TimerSource {
FromWorker,
}
/// The id to be used for a TimerEvent is defined by the corresponding TimerEventRequest.
/// The id to be used for a `TimerEvent` is defined by the corresponding `TimerEventRequest`.
#[derive(PartialEq, Eq, Copy, Clone, Debug, HeapSizeOf, Deserialize, Serialize)]
pub struct TimerEventId(pub u32);