diff options
| author | Gareth Daniel Smith <garethdanielsmith@gmail.com> | 2012-07-04 22:53:12 +0100 |
|---|---|---|
| committer | Brian Anderson <banderson@mozilla.com> | 2012-07-04 19:18:13 -0700 |
| commit | be0141666dd12316034499db12ee9fcf9ba648dd (patch) | |
| tree | 7d4c985a73e9a85de0e6c1bf2beeed44ebbd0102 /src/libcore/uint-template.rs | |
| parent | bfa43ca3011bd1296cb1797ad3ea1c5dc4056749 (diff) | |
convert doc-attributes to doc-comments using ./src/etc/sugarise-doc-comments.py (and manually tweaking) - for issue #2498
Diffstat (limited to 'src/libcore/uint-template.rs')
| -rw-r--r-- | src/libcore/uint-template.rs | 50 |
1 files changed, 25 insertions, 25 deletions
diff --git a/src/libcore/uint-template.rs b/src/libcore/uint-template.rs index 7f4ffe97c01..91b9eb856e4 100644 --- a/src/libcore/uint-template.rs +++ b/src/libcore/uint-template.rs @@ -38,7 +38,7 @@ pure fn is_nonpositive(x: T) -> bool { x <= 0 as T } pure fn is_nonnegative(x: T) -> bool { x >= 0 as T } #[inline(always)] -#[doc = "Iterate over the range [`lo`..`hi`)"] +/// Iterate over the range [`lo`..`hi`) fn range(lo: T, hi: T, it: fn(T) -> bool) { let mut i = lo; while i < hi { @@ -47,7 +47,7 @@ fn range(lo: T, hi: T, it: fn(T) -> bool) { } } -#[doc = "Computes the bitwise complement"] +/// Computes the bitwise complement pure fn compl(i: T) -> T { max_value ^ i } @@ -76,18 +76,18 @@ impl num of num::num for T { fn from_int(n: int) -> T { ret n as T; } } -#[doc = " -Parse a buffer of bytes - -# Arguments - -* buf - A byte buffer -* radix - The base of the number - -# Failure - -`buf` must not be empty -"] +/** + * Parse a buffer of bytes + * + * # Arguments + * + * * buf - A byte buffer + * * radix - The base of the number + * + * # Failure + * + * `buf` must not be empty + */ fn parse_buf(buf: ~[u8], radix: uint) -> option<T> { if vec::len(buf) == 0u { ret none; } let mut i = vec::len(buf) - 1u; @@ -104,10 +104,10 @@ fn parse_buf(buf: ~[u8], radix: uint) -> option<T> { }; } -#[doc = "Parse a string to an int"] +/// Parse a string to an int fn from_str(s: str) -> option<T> { parse_buf(str::bytes(s), 10u) } -#[doc = "Parse a string as an unsigned integer."] +/// Parse a string as an unsigned integer. fn from_str_radix(buf: str, radix: u64) -> option<u64> { if str::len(buf) == 0u { ret none; } let mut i = str::len(buf) - 1u; @@ -123,13 +123,13 @@ fn from_str_radix(buf: str, radix: u64) -> option<u64> { }; } -#[doc = " -Convert to a string in a given base - -# Failure - -Fails if `radix` < 2 or `radix` > 16 -"] +/** + * Convert to a string in a given base + * + * # Failure + * + * Fails if `radix` < 2 or `radix` > 16 + */ fn to_str(num: T, radix: uint) -> str { do to_str_bytes(false, num, radix) |slice| { do vec::unpack_slice(slice) |p, len| { @@ -138,7 +138,7 @@ fn to_str(num: T, radix: uint) -> str { } } -#[doc = "Low-level helper routine for string conversion."] +/// Low-level helper routine for string conversion. fn to_str_bytes<U>(neg: bool, num: T, radix: uint, f: fn(v: &[u8]) -> U) -> U { @@ -203,7 +203,7 @@ fn to_str_bytes<U>(neg: bool, num: T, radix: uint, } } -#[doc = "Convert to a string"] +/// Convert to a string fn str(i: T) -> str { ret to_str(i, 10u); } #[test] |
