e30199f7a9
This PR is part of the issue #3492. # Objective - Add and update the bevy_tasks documentation to achieve a 100% documentation coverage (sans `prelude` module) - Add the #![warn(missing_docs)] lint to keep the documentation coverage for the future. ## Solution - Add and update the bevy_math documentation. - Add the #![warn(missing_docs)] lint. - Added doctest wherever there should be in the missing docs.
41 lines
994 B
Rust
41 lines
994 B
Rust
#![warn(missing_docs)]
|
|
#![doc = include_str!("../README.md")]
|
|
|
|
mod slice;
|
|
pub use slice::{ParallelSlice, ParallelSliceMut};
|
|
|
|
mod task;
|
|
pub use task::Task;
|
|
|
|
#[cfg(not(target_arch = "wasm32"))]
|
|
mod task_pool;
|
|
#[cfg(not(target_arch = "wasm32"))]
|
|
pub use task_pool::{Scope, TaskPool, TaskPoolBuilder};
|
|
|
|
#[cfg(target_arch = "wasm32")]
|
|
mod single_threaded_task_pool;
|
|
#[cfg(target_arch = "wasm32")]
|
|
pub use single_threaded_task_pool::{Scope, TaskPool, TaskPoolBuilder};
|
|
|
|
mod usages;
|
|
pub use usages::{AsyncComputeTaskPool, ComputeTaskPool, IoTaskPool};
|
|
|
|
mod countdown_event;
|
|
pub use countdown_event::CountdownEvent;
|
|
|
|
mod iter;
|
|
pub use iter::ParallelIterator;
|
|
|
|
#[allow(missing_docs)]
|
|
pub mod prelude {
|
|
#[doc(hidden)]
|
|
pub use crate::{
|
|
iter::ParallelIterator,
|
|
slice::{ParallelSlice, ParallelSliceMut},
|
|
usages::{AsyncComputeTaskPool, ComputeTaskPool, IoTaskPool},
|
|
};
|
|
}
|
|
|
|
pub use num_cpus::get as logical_core_count;
|
|
pub use num_cpus::get_physical as physical_core_count;
|