From 5007e66043b2fbeffbd9da9c7880a93d599479e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Emilio=20Cobos=20=C3=81lvarez?= Date: Sat, 31 Dec 2016 03:38:23 +0100 Subject: [PATCH] style: Document the timer module. --- components/style/timer.rs | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/components/style/timer.rs b/components/style/timer.rs index 619e93e80f1..b77563b5ffb 100644 --- a/components/style/timer.rs +++ b/components/style/timer.rs @@ -1,14 +1,19 @@ /* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ + +#![deny(missing_docs)] + +//! A timer module, used to define a `Timer` type, that is controlled by script. + use time; -/// The `TimerMode` is used to determine what time should the `Timer` return, -/// either a fixed value (in the `Test` mode), or the actual time (in the -/// `Current` mode). +/// The `TimerMode` is used to determine what time should the `Timer` return. #[derive(Debug, Clone)] enum TimerMode { + /// The timer should return a fixed value. Test(f64), + /// The timer should return the actual time. Current, }