From d7f76ca5495d2d1ab364b7a5b8e4cd2f069e3457 Mon Sep 17 00:00:00 2001 From: Corey Farwell Date: Wed, 7 Sep 2016 21:19:34 -0400 Subject: [PATCH] Add documentation links. --- src/event_loop/timeout.rs | 4 +++- src/io/copy.rs | 4 +++- src/io/flush.rs | 4 +++- src/io/read_exact.rs | 4 +++- src/io/read_to_end.rs | 4 +++- src/io/write_all.rs | 4 +++- 6 files changed, 18 insertions(+), 6 deletions(-) diff --git a/src/event_loop/timeout.rs b/src/event_loop/timeout.rs index 98320019d..a4230dfd5 100644 --- a/src/event_loop/timeout.rs +++ b/src/event_loop/timeout.rs @@ -41,8 +41,10 @@ impl LoopHandle { } } -/// Return value from the `LoopHandle::add_timeout` method, a future that will +/// Return value from the [`LoopHandle::add_timeout`] method, a future that will /// resolve to a `TimeoutToken` to configure the behavior of that timeout. +/// +/// [`LoopHandle::add_timeout`]: struct.LoopHandle.html#method.add_timeout pub struct AddTimeout { inner: LoopFuture<(usize, Instant), Instant>, } diff --git a/src/io/copy.rs b/src/io/copy.rs index 04a5470b4..3884a30b5 100644 --- a/src/io/copy.rs +++ b/src/io/copy.rs @@ -4,8 +4,10 @@ use futures::{Future, Poll}; /// A future which will copy all data from a reader into a writer. /// -/// Created by the `copy` function, this future will resolve to the number of +/// Created by the [`copy`] function, this future will resolve to the number of /// bytes copied or an error if one happens. +/// +/// [`copy`]: fn.copy.html pub struct Copy { reader: R, read_done: bool, diff --git a/src/io/flush.rs b/src/io/flush.rs index 3e42073d9..f65164c08 100644 --- a/src/io/flush.rs +++ b/src/io/flush.rs @@ -6,7 +6,9 @@ use futures::{Poll, Future, Async}; /// /// Resolves to the underlying I/O object once the flush operation is complete. /// -/// Created by the `flush` function. +/// Created by the [`flush`] function. +/// +/// [`flush`]: fn.flush.html pub struct Flush { a: Option, } diff --git a/src/io/read_exact.rs b/src/io/read_exact.rs index 990b6ad61..bb0cea135 100644 --- a/src/io/read_exact.rs +++ b/src/io/read_exact.rs @@ -6,7 +6,9 @@ use futures::{Poll, Future}; /// A future which can be used to easily read exactly enough bytes to fill /// a buffer. /// -/// Created by the `read_exact` function. +/// Created by the [`read_exact`] function. +/// +/// [`read_exact`]: fn.read_exact.html pub struct ReadExact { state: State, } diff --git a/src/io/read_to_end.rs b/src/io/read_to_end.rs index 4fbf7b042..63d5a82a5 100644 --- a/src/io/read_to_end.rs +++ b/src/io/read_to_end.rs @@ -6,7 +6,9 @@ use futures::{Poll, Future}; /// A future which can be used to easily read the entire contents of a stream /// into a vector. /// -/// Created by the `read_to_end` function. +/// Created by the [`read_to_end`] function. +/// +/// [`read_to_end`]: fn.read_to_end.html pub struct ReadToEnd { state: State, } diff --git a/src/io/write_all.rs b/src/io/write_all.rs index 3324c201e..949db4750 100644 --- a/src/io/write_all.rs +++ b/src/io/write_all.rs @@ -5,7 +5,9 @@ use futures::{Poll, Future}; /// A future used to write the entire contents of some data to a stream. /// -/// This is created by the `write_all` top-level method. +/// This is created by the [`write_all`] top-level method. +/// +/// [`write_all`]: fn.write_all.html pub struct WriteAll { state: State, }