diff options
| author | Brendan Zabarauskas <bjzaba@yahoo.com.au> | 2013-04-26 09:55:49 +1000 |
|---|---|---|
| committer | Brendan Zabarauskas <bjzaba@yahoo.com.au> | 2013-04-26 09:55:49 +1000 |
| commit | dbc2e99693eb20da9b9823bc11953835b156802f (patch) | |
| tree | 72b6dcb39840c2a3fac238ad3310445c294b436d /src/libcore/num/uint-template | |
| parent | ad0b337036f2f9076852d5d6701ec302e3cce101 (diff) | |
| download | rust-dbc2e99693eb20da9b9823bc11953835b156802f.tar.gz rust-dbc2e99693eb20da9b9823bc11953835b156802f.zip | |
Use `///` doc-comment form instead of `/** */`
Diffstat (limited to 'src/libcore/num/uint-template')
| -rw-r--r-- | src/libcore/num/uint-template/uint.rs | 128 |
1 files changed, 64 insertions, 64 deletions
diff --git a/src/libcore/num/uint-template/uint.rs b/src/libcore/num/uint-template/uint.rs index efcf68aba31..5eaa27fb7a0 100644 --- a/src/libcore/num/uint-template/uint.rs +++ b/src/libcore/num/uint-template/uint.rs @@ -31,74 +31,74 @@ pub mod inst { #[cfg(target_arch = "x86_64")] pub static bits: uint = 64; - /** - * Divide two numbers, return the result, rounded up. - * - * # Arguments - * - * * x - an integer - * * y - an integer distinct from 0u - * - * # Return value - * - * The smallest integer `q` such that `x/y <= q`. - */ + /// + /// Divide two numbers, return the result, rounded up. + /// + /// # Arguments + /// + /// * x - an integer + /// * y - an integer distinct from 0u + /// + /// # Return value + /// + /// The smallest integer `q` such that `x/y <= q`. + /// pub fn div_ceil(x: uint, y: uint) -> uint { let div = x / y; if x % y == 0u { div } else { div + 1u } } - /** - * Divide two numbers, return the result, rounded to the closest integer. - * - * # Arguments - * - * * x - an integer - * * y - an integer distinct from 0u - * - * # Return value - * - * The integer `q` closest to `x/y`. - */ + /// + /// Divide two numbers, return the result, rounded to the closest integer. + /// + /// # Arguments + /// + /// * x - an integer + /// * y - an integer distinct from 0u + /// + /// # Return value + /// + /// The integer `q` closest to `x/y`. + /// pub fn div_round(x: uint, y: uint) -> uint { let div = x / y; if x % y * 2u < y { div } else { div + 1u } } - /** - * Divide two numbers, return the result, rounded down. - * - * Note: This is the same function as `div`. - * - * # Arguments - * - * * x - an integer - * * y - an integer distinct from 0u - * - * # Return value - * - * The smallest integer `q` such that `x/y <= q`. This - * is either `x/y` or `x/y + 1`. - */ + /// + /// Divide two numbers, return the result, rounded down. + /// + /// Note: This is the same function as `div`. + /// + /// # Arguments + /// + /// * x - an integer + /// * y - an integer distinct from 0u + /// + /// # Return value + /// + /// The smallest integer `q` such that `x/y <= q`. This + /// is either `x/y` or `x/y + 1`. + /// pub fn div_floor(x: uint, y: uint) -> uint { return x / y; } - /** - * Iterate over the range [`lo`..`hi`), or stop when requested - * - * # Arguments - * - * * lo - The integer at which to start the loop (included) - * * hi - The integer at which to stop the loop (excluded) - * * it - A block to execute with each consecutive integer of the range. - * Return `true` to continue, `false` to stop. - * - * # Return value - * - * `true` If execution proceeded correctly, `false` if it was interrupted, - * that is if `it` returned `false` at any point. - */ + /// + /// Iterate over the range [`lo`..`hi`), or stop when requested + /// + /// # Arguments + /// + /// * lo - The integer at which to start the loop (included) + /// * hi - The integer at which to stop the loop (excluded) + /// * it - A block to execute with each consecutive integer of the range. + /// Return `true` to continue, `false` to stop. + /// + /// # Return value + /// + /// `true` If execution proceeded correctly, `false` if it was interrupted, + /// that is if `it` returned `false` at any point. + /// pub fn iterate(lo: uint, hi: uint, it: &fn(uint) -> bool) -> bool { let mut i = lo; while i < hi { @@ -110,16 +110,16 @@ pub mod inst { impl iter::Times for uint { #[inline(always)] - /** - * A convenience form for basic iteration. Given a uint `x`, - * `for x.times { ... }` executes the given block x times. - * - * Equivalent to `for uint::range(0, x) |_| { ... }`. - * - * Not defined on all integer types to permit unambiguous - * use with integer literals of inferred integer-type as - * the self-value (eg. `for 100.times { ... }`). - */ + /// + /// A convenience form for basic iteration. Given a uint `x`, + /// `for x.times { ... }` executes the given block x times. + /// + /// Equivalent to `for uint::range(0, x) |_| { ... }`. + /// + /// Not defined on all integer types to permit unambiguous + /// use with integer literals of inferred integer-type as + /// the self-value (eg. `for 100.times { ... }`). + /// fn times(&self, it: &fn() -> bool) { let mut i = *self; while i > 0 { |
