diff --git a/src/librustuv/lib.rs b/src/librustuv/lib.rs index 4f1ca0b02d3d3..d994a9aece214 100644 --- a/src/librustuv/lib.rs +++ b/src/librustuv/lib.rs @@ -88,10 +88,7 @@ mod homing; mod queue; mod rc; -/// The implementation of `rtio` for libuv pub mod uvio; - -/// C bindings to libuv pub mod uvll; pub mod file; diff --git a/src/librustuv/uvio.rs b/src/librustuv/uvio.rs index 81d7ac6601e23..77b1fd1e4c4ba 100644 --- a/src/librustuv/uvio.rs +++ b/src/librustuv/uvio.rs @@ -8,6 +8,8 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. +//! The implementation of `rtio` for libuv + use std::c_str::CString; use std::cast; use std::io::IoError; diff --git a/src/libstd/rt/backtrace.rs b/src/libstd/rt/backtrace.rs index 85699cdfebc02..26494f1acd9ee 100644 --- a/src/libstd/rt/backtrace.rs +++ b/src/libstd/rt/backtrace.rs @@ -8,6 +8,8 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. +//! Simple backtrace functionality (to print on failure) + #![allow(non_camel_case_types)] use char::Char; diff --git a/src/libstd/rt/global_heap.rs b/src/libstd/rt/global_heap.rs index 01949a7057bc4..b9c0a02d7d228 100644 --- a/src/libstd/rt/global_heap.rs +++ b/src/libstd/rt/global_heap.rs @@ -8,6 +8,9 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. + +//! The global (exchange) heap. + use libc::{c_void, size_t, free, malloc, realloc}; use ptr::{RawPtr, mut_null}; use intrinsics::abort; diff --git a/src/libstd/rt/mod.rs b/src/libstd/rt/mod.rs index a61443d335acb..b407bf8897ca4 100644 --- a/src/libstd/rt/mod.rs +++ b/src/libstd/rt/mod.rs @@ -85,44 +85,44 @@ pub mod shouldnt_be_public { // Internal macros used by the runtime. mod macros; -/// The global (exchange) heap. +// The global (exchange) heap. pub mod global_heap; -/// Implementations of language-critical runtime features like @. +// Implementations of language-critical runtime features like @. pub mod task; -/// The EventLoop and internal synchronous I/O interface. +// The EventLoop and internal synchronous I/O interface. pub mod rtio; -/// The Local trait for types that are accessible via thread-local -/// or task-local storage. +// The Local trait for types that are accessible via thread-local +// or task-local storage. pub mod local; -/// Bindings to system threading libraries. +// Bindings to system threading libraries. pub mod thread; -/// The runtime configuration, read from environment variables. +// The runtime configuration, read from environment variables. pub mod env; -/// The local, managed heap +// The local, managed heap pub mod local_heap; -/// The runtime needs to be able to put a pointer into thread-local storage. +// The runtime needs to be able to put a pointer into thread-local storage. mod local_ptr; -/// Bindings to pthread/windows thread-local storage. +// Bindings to pthread/windows thread-local storage. mod thread_local_storage; -/// Stack unwinding +// Stack unwinding pub mod unwind; -/// The interface to libunwind that rust is using. +// The interface to libunwind that rust is using. mod libunwind; -/// Simple backtrace functionality (to print on failure) +// Simple backtrace functionality (to print on failure) pub mod backtrace; -/// Just stuff +// Just stuff mod util; // Global command line argument storage diff --git a/src/libstd/rt/rtio.rs b/src/libstd/rt/rtio.rs index f3c7fdaf7105b..fc8c79549af23 100644 --- a/src/libstd/rt/rtio.rs +++ b/src/libstd/rt/rtio.rs @@ -8,6 +8,8 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. +//! The EventLoop and internal synchronous I/O interface. + use c_str::CString; use cast; use comm::{Sender, Receiver}; diff --git a/src/libstd/rt/unwind.rs b/src/libstd/rt/unwind.rs index 68d63949ae601..4f84202f8f87e 100644 --- a/src/libstd/rt/unwind.rs +++ b/src/libstd/rt/unwind.rs @@ -8,6 +8,8 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. +//! Stack unwinding + // Implementation of Rust stack unwinding // // For background on exception handling and stack unwinding please see diff --git a/src/libsyntax/parse/classify.rs b/src/libsyntax/parse/classify.rs index d6dcb956f25c6..b160593b04975 100644 --- a/src/libsyntax/parse/classify.rs +++ b/src/libsyntax/parse/classify.rs @@ -8,9 +8,9 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. -/* - Predicates on exprs and stmts that the pretty-printer and parser use - */ +//! Routines the parser uses to classify AST nodes + +// Predicates on exprs and stmts that the pretty-printer and parser use use ast; diff --git a/src/libsyntax/parse/common.rs b/src/libsyntax/parse/common.rs index 0d40638d3a7dc..3c3f0c7a82044 100644 --- a/src/libsyntax/parse/common.rs +++ b/src/libsyntax/parse/common.rs @@ -8,6 +8,8 @@ // option. This file may not be copied, modified, or distributed // except according to those terms. +//! Common routines shared by parser mods + use parse::token; // SeqSep : a sequence separator (token) diff --git a/src/libsyntax/parse/mod.rs b/src/libsyntax/parse/mod.rs index 122cc37dfb66a..0d3ae3b5cb816 100644 --- a/src/libsyntax/parse/mod.rs +++ b/src/libsyntax/parse/mod.rs @@ -28,13 +28,8 @@ pub mod token; pub mod comments; pub mod attr; -/// Common routines shared by parser mods pub mod common; - -/// Routines the parser uses to classify AST nodes pub mod classify; - -/// Reporting obsolete syntax pub mod obsolete; // info about a parsing session.