Skip to content

Commit 70f55a7

Browse files
authored
Rollup merge of #76853 - denisvasilik:intra-doc-links-core-wake, r=jyn514
Use intra-doc links in library/core/src/task/wake.rs Helps with #75080. @rustbot modify labels: T-doc, A-intra-doc-links
2 parents 6d0890e + 8e9ad31 commit 70f55a7

File tree

1 file changed

+3
-26
lines changed

1 file changed

+3
-26
lines changed

library/core/src/task/wake.rs

+3-26
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,8 @@ use crate::marker::{PhantomData, Unpin};
88
///
99
/// [vtable]: https://en.wikipedia.org/wiki/Virtual_method_table
1010
///
11-
/// It consists of a data pointer and a [virtual function pointer table (vtable)][vtable] that
12-
/// customizes the behavior of the `RawWaker`.
13-
///
14-
/// [`Waker`]: struct.Waker.html
11+
/// It consists of a data pointer and a [virtual function pointer table (vtable)][vtable]
12+
/// that customizes the behavior of the `RawWaker`.
1513
#[derive(PartialEq, Debug)]
1614
#[stable(feature = "futures_api", since = "1.36.0")]
1715
pub struct RawWaker {
@@ -52,12 +50,10 @@ impl RawWaker {
5250
/// The pointer passed to all functions inside the vtable is the `data` pointer
5351
/// from the enclosing [`RawWaker`] object.
5452
///
55-
/// The functions inside this struct are only intended be called on the `data`
53+
/// The functions inside this struct are only intended to be called on the `data`
5654
/// pointer of a properly constructed [`RawWaker`] object from inside the
5755
/// [`RawWaker`] implementation. Calling one of the contained functions using
5856
/// any other `data` pointer will cause undefined behavior.
59-
///
60-
/// [`RawWaker`]: struct.RawWaker.html
6157
#[stable(feature = "futures_api", since = "1.36.0")]
6258
#[derive(PartialEq, Copy, Clone, Debug)]
6359
pub struct RawWakerVTable {
@@ -68,9 +64,6 @@ pub struct RawWakerVTable {
6864
/// required for this additional instance of a [`RawWaker`] and associated
6965
/// task. Calling `wake` on the resulting [`RawWaker`] should result in a wakeup
7066
/// of the same task that would have been awoken by the original [`RawWaker`].
71-
///
72-
/// [`Waker`]: struct.Waker.html
73-
/// [`RawWaker`]: struct.RawWaker.html
7467
clone: unsafe fn(*const ()) -> RawWaker,
7568

7669
/// This function will be called when `wake` is called on the [`Waker`].
@@ -79,28 +72,20 @@ pub struct RawWakerVTable {
7972
/// The implementation of this function must make sure to release any
8073
/// resources that are associated with this instance of a [`RawWaker`] and
8174
/// associated task.
82-
///
83-
/// [`Waker`]: struct.Waker.html
84-
/// [`RawWaker`]: struct.RawWaker.html
8575
wake: unsafe fn(*const ()),
8676

8777
/// This function will be called when `wake_by_ref` is called on the [`Waker`].
8878
/// It must wake up the task associated with this [`RawWaker`].
8979
///
9080
/// This function is similar to `wake`, but must not consume the provided data
9181
/// pointer.
92-
///
93-
/// [`Waker`]: struct.Waker.html
94-
/// [`RawWaker`]: struct.RawWaker.html
9582
wake_by_ref: unsafe fn(*const ()),
9683

9784
/// This function gets called when a [`RawWaker`] gets dropped.
9885
///
9986
/// The implementation of this function must make sure to release any
10087
/// resources that are associated with this instance of a [`RawWaker`] and
10188
/// associated task.
102-
///
103-
/// [`RawWaker`]: struct.RawWaker.html
10489
drop: unsafe fn(*const ()),
10590
}
10691

@@ -142,9 +127,6 @@ impl RawWakerVTable {
142127
/// The implementation of this function must make sure to release any
143128
/// resources that are associated with this instance of a [`RawWaker`] and
144129
/// associated task.
145-
///
146-
/// [`Waker`]: struct.Waker.html
147-
/// [`RawWaker`]: struct.RawWaker.html
148130
#[rustc_promotable]
149131
#[stable(feature = "futures_api", since = "1.36.0")]
150132
// `rustc_allow_const_fn_ptr` is a hack that should not be used anywhere else
@@ -208,8 +190,6 @@ impl fmt::Debug for Context<'_> {
208190
/// executor-specific wakeup behavior.
209191
///
210192
/// Implements [`Clone`], [`Send`], and [`Sync`].
211-
///
212-
/// [`RawWaker`]: struct.RawWaker.html
213193
#[repr(transparent)]
214194
#[stable(feature = "futures_api", since = "1.36.0")]
215195
pub struct Waker {
@@ -275,9 +255,6 @@ impl Waker {
275255
/// The behavior of the returned `Waker` is undefined if the contract defined
276256
/// in [`RawWaker`]'s and [`RawWakerVTable`]'s documentation is not upheld.
277257
/// Therefore this method is unsafe.
278-
///
279-
/// [`RawWaker`]: struct.RawWaker.html
280-
/// [`RawWakerVTable`]: struct.RawWakerVTable.html
281258
#[inline]
282259
#[stable(feature = "futures_api", since = "1.36.0")]
283260
pub unsafe fn from_raw(waker: RawWaker) -> Waker {

0 commit comments

Comments
 (0)