summaryrefslogtreecommitdiff
path: root/src/core/cpu/worker.h
diff options
context:
space:
mode:
Diffstat (limited to 'src/core/cpu/worker.h')
-rw-r--r--src/core/cpu/worker.h12
1 files changed, 12 insertions, 0 deletions
diff --git a/src/core/cpu/worker.h b/src/core/cpu/worker.h
index ec462f7..66130c6 100644
--- a/src/core/cpu/worker.h
+++ b/src/core/cpu/worker.h
@@ -25,9 +25,21 @@
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
+/**
+ * \file worker.h
+ * \brief Function run by the CPU worker threads
+ */
+
#ifndef __CPU_WORKER_H__
#define __CPU_WORKER_H__
+/**
+ * \brief Main loop of the CPU worker threads
+ *
+ * This function is run by as many thread as they are CPU cores on the host
+ * system. As explained by \ref events , this function waits until there
+ * are \c Coal::Event objects to process and handle them.
+ */
void *worker(void *data);
#endif