- added documentation

commons/zenoh-task/src/lib.rs

@@ -39,6 +39,9 @@ impl TaskController {
             running_task_id_to_handle: Arc::new(Mutex::new(HashMap::<Uuid, Option<JoinHandle<()>>>::new()))
         }
     }
+
+    /// Spawns a task (similarly to task::spawn) that can be later terminated by call to terminate_all()
+    /// Task output is ignored
     pub fn spawn<F, T>(&self, future: F)
     where
         F: Future<Output = T> + Send + 'static,
@@ -68,6 +71,7 @@ impl TaskController {
         }
     }
 
+    /// Terminates all prevously spawned tasks
     pub fn terminate_all(&self) {
         let tasks: Vec<(Uuid, Option<JoinHandle<()>>)> = self.running_task_id_to_handle.lock().unwrap().drain().collect();
         for (_id, jh) in tasks {