about summary refs log tree commit diff
path: root/src/libstd
diff options
context:
space:
mode:
Diffstat (limited to 'src/libstd')
-rw-r--r--src/libstd/num/uint_macros.rs15
1 files changed, 12 insertions, 3 deletions
diff --git a/src/libstd/num/uint_macros.rs b/src/libstd/num/uint_macros.rs
index c2e722f9e0e..bdb74f7e191 100644
--- a/src/libstd/num/uint_macros.rs
+++ b/src/libstd/num/uint_macros.rs
@@ -64,9 +64,18 @@ pub fn ge(x: $T, y: $T) -> bool { x >= y }
 pub fn gt(x: $T, y: $T) -> bool { x > y }
 
 #[inline(always)]
-///
-/// Iterate over the range [`start`,`start`+`step`..`stop`)
-///
+/**
+ * Iterate through a range with a given step value.
+ *
+ * # Examples
+ * ~~~ {.rust}
+ * let nums = [1,2,3,4,5,6,7];
+ *
+ * for uint::range_step(0, nums.len() - 1, 2) |i| {
+ *     println(fmt!("%d & %d", nums[i], nums[i+1]));
+ * }
+ * ~~~
+ */
 pub fn range_step(start: $T, stop: $T, step: $T_SIGNED, it: &fn($T) -> bool) -> bool {
     let mut i = start;
     if step == 0 {