diff options
| author | Brian Anderson <banderson@mozilla.com> | 2015-07-20 11:21:02 -0700 |
|---|---|---|
| committer | Brian Anderson <banderson@mozilla.com> | 2015-07-20 13:18:06 -0700 |
| commit | 8497c428e5da665917304ae404b9b3e7b0a94466 (patch) | |
| tree | b3d872537c5d91ecb13a725de3940e82ff5f0648 /src/libstd/array.rs | |
| parent | 44dd247cd5ced8ae8a8c6f1d04463abce21c8e9e (diff) | |
| download | rust-8497c428e5da665917304ae404b9b3e7b0a94466.tar.gz rust-8497c428e5da665917304ae404b9b3e7b0a94466.zip | |
std: Create separate docs for the primitives
Having the primitive and module docs derived from the same source causes problems, primarily that they can't contain hyperlinks cross-referencing each other. This crates dedicated private modules in `std` to document the primitive types, then for all primitives that have a corresponding module, puts hyperlinks in moth the primitive docs and the module docs cross-linking each other. This should help clear up confusion when readers find themselves on the wrong page.
Diffstat (limited to 'src/libstd/array.rs')
| -rw-r--r-- | src/libstd/array.rs | 55 |
1 files changed, 0 insertions, 55 deletions
diff --git a/src/libstd/array.rs b/src/libstd/array.rs deleted file mode 100644 index f6d133319c8..00000000000 --- a/src/libstd/array.rs +++ /dev/null @@ -1,55 +0,0 @@ -// Copyright 2015 The Rust Project Developers. See the COPYRIGHT -// file at the top-level directory of this distribution and at -// http://rust-lang.org/COPYRIGHT. -// -// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or -// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license -// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your -// option. This file may not be copied, modified, or distributed -// except according to those terms. - -//! A fixed-size array, denoted `[T; N]`, for the element type, `T`, and -//! the non-negative compile time constant size, `N`. -//! -//! Arrays values are created either with an explicit expression that lists -//! each element: `[x, y, z]` or a repeat expression: `[x; N]`. The repeat -//! expression requires that the element type is `Copy`. -//! -//! The type `[T; N]` is `Copy` if `T: Copy`. -//! -//! Arrays of sizes from 0 to 32 (inclusive) implement the following traits -//! if the element type allows it: -//! -//! - `Clone` -//! - `Debug` -//! - `IntoIterator` (implemented for `&[T; N]` and `&mut [T; N]`) -//! - `PartialEq`, `PartialOrd`, `Ord`, `Eq` -//! - `Hash` -//! - `AsRef`, `AsMut` -//! -//! Arrays dereference to [slices (`[T]`)][slice], so their methods can be called -//! on arrays. -//! -//! [slice]: primitive.slice.html -//! -//! Rust does not currently support generics over the size of an array type. -//! -//! # Examples -//! -//! ``` -//! let mut array: [i32; 3] = [0; 3]; -//! -//! array[1] = 1; -//! array[2] = 2; -//! -//! assert_eq!([1, 2], &array[1..]); -//! -//! // This loop prints: 0 1 2 -//! for x in &array { -//! print!("{} ", x); -//! } -//! -//! ``` -//! - -#![doc(primitive = "array")] |
