Skip to content

Commit 0f9b9a5

Browse files
author
blake2-ppc
committed
extra: Mention extra::container::Deque trait in doc for RingBuf and DList
1 parent b2b88b3 commit 0f9b9a5

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

src/libextra/dlist.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
//! A doubly-linked list with owned nodes.
1212
//!
1313
//! The DList allows pushing and popping elements at either end.
14+
//!
15+
//! DList implements the trait Deque. It should be imported with `use
16+
//! extra::container::Deque`.
1417
1518

1619
// DList is constructed like a singly-linked list over the field `next`.
@@ -27,7 +30,7 @@ use std::iterator::FromIterator;
2730

2831
use container::Deque;
2932

30-
/// A doubly-linked list
33+
/// A doubly-linked list.
3134
pub struct DList<T> {
3235
priv length: uint,
3336
priv list_head: Link<T>,

src/libextra/ringbuf.rs

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@
99
// except according to those terms.
1010

1111
//! A double-ended queue implemented as a circular buffer
12+
//!
13+
//! RingBuf implements the trait Deque. It should be imported with `use
14+
//! extra::container::Deque`.
1215
1316
use std::num;
1417
use std::util;
@@ -21,7 +24,7 @@ use container::Deque;
2124
static INITIAL_CAPACITY: uint = 8u; // 2^3
2225
static MINIMUM_CAPACITY: uint = 2u;
2326

24-
#[allow(missing_doc)]
27+
/// RingBuf is a circular buffer that implements Deque.
2528
#[deriving(Clone)]
2629
pub struct RingBuf<T> {
2730
priv nelts: uint,

0 commit comments

Comments
 (0)