Skip to content

Commit e5f8026

Browse files
committed
core: Make sure every module at least has a one-line description
1 parent 113fbfc commit e5f8026

File tree

6 files changed

+30
-5
lines changed

6 files changed

+30
-5
lines changed

src/libcore/cast.rs

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11+
//! Unsafe casting functions
12+
1113
pub mod rusti {
1214
#[abi = "rust-intrinsic"]
1315
#[link_name = "rusti"]

src/libcore/cell.rs

+7-3
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,17 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11+
//! A mutable, nullable memory location
12+
1113
use cast::transmute;
1214
use option;
1315
use prelude::*;
1416

15-
/// A dynamic, mutable location.
16-
///
17-
/// Similar to a mutable option type, but friendlier.
17+
/*
18+
A dynamic, mutable location.
19+
20+
Similar to a mutable option type, but friendlier.
21+
*/
1822

1923
pub struct Cell<T> {
2024
mut value: Option<T>

src/libcore/clone.rs

+13-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,20 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11-
/**
12-
Clonable types are copied with the clone method
11+
/*! The Clone trait for types that cannot be "implicitly copied"
12+
13+
In Rust, some simple types are "implicitly copyable" and when you
14+
assign them or pass them as arguments, the receiver will get a copy,
15+
leaving the original value in place. These types do not require
16+
allocation to copy and do not have finalizers (i.e. they do not
17+
contain owned pointers or implement `Drop`), so the compiler considers
18+
them cheap and safe to copy and automatically implements the `Copy`
19+
trait for them. For other types copies must be made explicitly,
20+
by convention implementing the `Clone` trait and calling the
21+
`clone` method.
22+
1323
*/
24+
1425
pub trait Clone {
1526
fn clone(&self) -> Self;
1627
}

src/libcore/comm.rs

+4
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,10 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11+
/*!
12+
Message passing
13+
*/
14+
1115
use cast;
1216
use either::{Either, Left, Right};
1317
use kinds::Owned;

src/libcore/condition.rs

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11+
/*! Condition handling */
12+
1113
use prelude::*;
1214
use task;
1315
use task::local_data::{local_data_pop, local_data_set};

src/libcore/rt/mod.rs

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
// option. This file may not be copied, modified, or distributed
99
// except according to those terms.
1010

11+
#[doc(hidden)];
12+
1113
use libc::c_char;
1214

1315
// Some basic logging

0 commit comments

Comments
 (0)