Author: NikolaRHristov

Source/Library.rs

@@ -0,0 +1,15 @@
+// @module Echo Crate
+// @description A high-performance, structured concurrency and task scheduling
+// library for Rust, built on top of `tokio` and a work-stealing queue. Echo is
+// designed to natively execute `Future`s, providing a robust runtime for
+// complex, asynchronous applications.
+//
+
+#![allow(non_snake_case, non_camel_case_types)]
+
+// --- Public API ---
+pub mod scheduler;
+pub mod task;
+
+// --- Internal Implementation ---
+mod queue;

Source/lib.rs

@@ -1,19 +1,15 @@
-
-
-/**
- * @module queue
- * @description This module provides the high-performance, concurrent queueing
- * implementations used by the Echo scheduler. These are internal components
- * of the library.
- */
+// @module queue
+// @description This module provides the high-performance, concurrent queueing
+// implementations used by the Echo scheduler. These are internal components
+// of the library.
+//
 
 #![allow(non_snake_case, non_camel_case_types)]
 
 mod StealingQueue;
 
-/**
- * Re-exports the `StealingQueue` for use within the `Echo` crate, but keeps it
- * private from external consumers.
- * @see StealingQueue
- */
+// Re-exports the `StealingQueue` for use within the `Echo` crate, but keeps it
+// private from external consumers.
+// @see StealingQueue
+//
 pub(crate) use self::StealingQueue::StealingQueue;

Source/queue/mod.rs

@@ -1,11 +1,8 @@
-
-
-/**
- * @module scheduler
- * @description This module defines the core public API for the Echo task scheduler.
- * It provides the `SchedulerBuilder` for configuration and the `Scheduler` itself
- * for managing the worker pool and submitting tasks.
- */
+// @module scheduler
+// @description This module defines the core public API for the Echo task
+// scheduler. It provides the `SchedulerBuilder` for configuration and the
+// `Scheduler` itself for managing the worker pool and submitting tasks.
+//
 
 #![allow(non_snake_case, non_camel_case_types)]
 
@@ -16,15 +13,11 @@ mod Worker;
 
 // --- Public Re-exports ---
 
-/**
- * The main scheduler struct that manages the worker pool and task execution.
- * @see Scheduler
- */
+// The main scheduler struct that manages the worker pool and task execution.
+// @see Scheduler
+//
 pub use self::Scheduler::Scheduler;
-
-/**
- * The fluent builder for creating and configuring a `Scheduler` instance.
- * This is the primary entry point for using the Echo library.
- * @see SchedulerBuilder
- */
+// The fluent builder for creating and configuring a `Scheduler` instance.
+// This is the primary entry point for using the Echo library.
+// @see SchedulerBuilder
 pub use self::SchedulerBuilder::SchedulerBuilder;

Source/scheduler/mod.rs

@@ -1,10 +1,7 @@
-
-
-/**
- * @module task
- * @description This module defines the core data structures for the Echo scheduler,
- * including the `Task` itself and its `Priority`.
- */
+// @module task
+// @description This module defines the core data structures for the Echo
+// scheduler, including the `Task` itself and its `Priority`.
+//
 
 #![allow(non_snake_case, non_camel_case_types)]
 
@@ -14,14 +11,10 @@ mod Task;
 
 // --- Public Re-exports ---
 
-/**
- * The enum representing the priority of a task.
- * @see Priority
- */
+// The enum representing the priority of a task.
+// @see Priority
+//
 pub use self::Priority::Priority;
-
-/**
- * The struct representing a single unit of work for the scheduler.
- * @see Task
- */
+// The struct representing a single unit of work for the scheduler.
+// @see Task
 pub use self::Task::Task;