aboutsummaryrefslogtreecommitdiffstats
path: root/components/script_traits
diff options
context:
space:
mode:
authorCorey Farwell <coreyf@rwell.org>2016-11-08 09:33:03 -0500
committerCorey Farwell <coreyf@rwell.org>2016-11-08 09:33:03 -0500
commit531289ebb7599f63b808affc25bd43a8140af43b (patch)
tree1f31dfa27185222251ef7a877bc9fb5a0aa08487 /components/script_traits
parent085c52dfbce125b9f777eadb1ed149e04548fc45 (diff)
downloadservo-531289ebb7599f63b808affc25bd43a8140af43b.tar.gz
servo-531289ebb7599f63b808affc25bd43a8140af43b.zip
Indicate items in doc comments as code-like.
Diffstat (limited to 'components/script_traits')
-rw-r--r--components/script_traits/lib.rs12
-rw-r--r--components/script_traits/script_msg.rs2
2 files changed, 7 insertions, 7 deletions
diff --git a/components/script_traits/lib.rs b/components/script_traits/lib.rs
index 557d1eb1139..ff0f41cbdec 100644
--- a/components/script_traits/lib.rs
+++ b/components/script_traits/lib.rs
@@ -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);
diff --git a/components/script_traits/script_msg.rs b/components/script_traits/script_msg.rs
index b73be67c023..7969218e5d3 100644
--- a/components/script_traits/script_msg.rs
+++ b/components/script_traits/script_msg.rs
@@ -45,7 +45,7 @@ pub enum EventResult {
/// A log entry reported to the constellation
/// We don't report all log entries, just serious ones.
-/// We need a separate type for this because LogLevel isn't serializable.
+/// We need a separate type for this because `LogLevel` isn't serializable.
#[derive(Clone, Debug, Deserialize, Serialize)]
pub enum LogEntry {
/// Panic, with a reason and backtrace