Skip to content

Commit

Permalink
more docs
Browse files Browse the repository at this point in the history
Signed-off-by: tison <wander4096@gmail.com>
  • Loading branch information
tisonkun committed Dec 17, 2024
1 parent f82522f commit 7bf06e4
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ Mea (Make Easy Async) is a runtime-agnostic library providing essential synchron
## Features

* [**Barrier**](https://docs.rs/mea/*/mea/barrier/struct.Barrier.html): A synchronization primitive that enables tasks to wait until all participants arrive.
* [**Condvar**](https://docs.rs/mea/*/mea/condvar/struct.Condvar.html): A condition variable that allows tasks to wait for a notification.
* [**Latch**](https://docs.rs/mea/*/mea/latch/struct.Latch.html): A synchronization primitive that allows one or more tasks to wait until a set of operations completes.
* [**Mutex**](https://docs.rs/mea/*/mea/mutex/struct.Mutex.html): A mutual exclusion primitive for protecting shared data.
* [**Semaphore**](https://docs.rs/mea/*/mea/semaphore/struct.Semaphore.html): A synchronization primitive that controls access to a shared resource.
Expand Down
4 changes: 2 additions & 2 deletions mea/src/condvar/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

//! A Condition Variable.
//! A condition variable that allows tasks to wait for a notification.
//!
//! # Examples
//!
Expand Down Expand Up @@ -60,7 +60,7 @@ use crate::mutex::MutexGuard;
#[cfg(test)]
mod tests;

/// A Condition Variable.
/// A condition variable that allows tasks to wait for a notification.
///
/// See the [module level documentation](self) for more.
pub struct Condvar {
Expand Down
12 changes: 7 additions & 5 deletions mea/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,13 @@
//!
//! ## Features
//!
//! * [`Barrier`] - A synchronization point where multiple tasks can wait until all participants
//! * [`Barrier`]: A synchronization point where multiple tasks can wait until all participants
//! arrive
//! * [`Latch`] - A single-use barrier that allows one or more tasks to wait until a signal is given
//! * [`Mutex`] - A mutual exclusion primitive for protecting shared data
//! * [`Semaphore`] - A synchronization primitive that controls access to a shared resource
//! * [`WaitGroup`] - A synchronization primitive that allows waiting for multiple tasks to complete
//! * [`Condvar`]: A condition variable that allows tasks to wait for a notification.
//! * [`Latch`]: A single-use barrier that allows one or more tasks to wait until a signal is given
//! * [`Mutex`]: A mutual exclusion primitive for protecting shared data
//! * [`Semaphore`]: A synchronization primitive that controls access to a shared resource
//! * [`WaitGroup`]: A synchronization primitive that allows waiting for multiple tasks to complete
//!
//! ## Runtime Agnostic
//!
Expand All @@ -43,6 +44,7 @@
//! multiple threads.
//!
//! [`Barrier`]: barrier::Barrier
//! [`Condvar`]: condvar::Condvar
//! [`Latch`]: latch::Latch
//! [`Mutex`]: mutex::Mutex
//! [`Semaphore`]: semaphore::Semaphore
Expand Down

0 comments on commit 7bf06e4

Please sign in to comment.