Added better documentation of executor

diff --git a/src/executor.c b/src/executor.c
index ce26d55077dd86b33edd7d2b9ab6348222e16492..dc4a547bc923ead67f4f4b7c38538dce15c89118 100644 (file)
--- a/src/executor.c
+++ b/src/executor.c
@@ -115,7 +115,12 @@ void forb_executor_unregister_object(forb_executor_t *executor, forb_object obj)
 }
 
 /** 
- * Executor's main loop which processes requests.
+ * Executor's main loop which executes object implementation methods
+ * upon request.
+ *
+ * The requests are represented by ::forb_exec_req_t and are enqueued
+ * to the executor's request queue by receiver threads of individual
+ * ports (forb_iop_receiver_thread()).
  * 
  * @param executor 
  * 

diff --git a/src/executor.h b/src/executor.h
index 42f73cd9fecd09c777ca391ed85a4df9f6b54f9a..0d08f4f4ff5455390e727bf3c27875ac297bc0ec 100644 (file)
--- a/src/executor.h
+++ b/src/executor.h
@@ -62,7 +62,13 @@
 
 /**
  * Executor structure.
- * 
+ *
+ * Executors provide a way for applications to determine which thread
+ * will execute requests for a particular object. After the executor
+ * structure is initialized by forb_executor_init(), several objects
+ * can be registered to it by forb_executor_register_object(). Then a
+ * loop which waits for requests and executes them by calling object
+ * implementations is started by forb_executor_run().
  */
 typedef struct forb_executor {
        fosa_mutex_t mutex;     /**< Mutex for protecting forb_executor_t::requests. */