diff options
author | David Robillard <d@drobilla.net> | 2014-07-31 20:39:26 +0000 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2014-07-31 20:39:26 +0000 |
commit | 1c67d8123580b5cf70b5530277ad8320e97174cd (patch) | |
tree | 7b2382e550b35c6d87362f8995198f640fd5fdad /lv2/lv2plug.in/ns/ext/worker | |
parent | 64e25ef4f27e9e82402ba1a361e8c443eefc93db (diff) | |
download | lv2-1c67d8123580b5cf70b5530277ad8320e97174cd.tar.xz |
Use Doxygen Markdown support for more human-readable doc comments.
Minor improvements to UI documentation.
Diffstat (limited to 'lv2/lv2plug.in/ns/ext/worker')
-rw-r--r-- | lv2/lv2plug.in/ns/ext/worker/worker.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/lv2/lv2plug.in/ns/ext/worker/worker.h b/lv2/lv2plug.in/ns/ext/worker/worker.h index 00b1039..6c9386b 100644 --- a/lv2/lv2plug.in/ns/ext/worker/worker.h +++ b/lv2/lv2plug.in/ns/ext/worker/worker.h @@ -50,7 +50,7 @@ typedef void* LV2_Worker_Respond_Handle; /** A function to respond to run() from the worker method. - The @p data MUST be safe for the host to copy and later pass to + The `data` MUST be safe for the host to copy and later pass to work_response(), and the host MUST guarantee that it will be eventually passed to work_response() if this function returns LV2_WORKER_SUCCESS. */ @@ -71,14 +71,14 @@ typedef struct _LV2_Worker_Interface { The worker method. This is called by the host in a non-realtime context as requested, possibly with an arbitrary message to handle. - A response can be sent to run() using @p respond. The plugin MUST NOT + A response can be sent to run() using `respond`. The plugin MUST NOT make any assumptions about which thread calls this method, other than the fact that there are no real-time requirements. @param instance The LV2 instance this is a method on. @param respond A function for sending a response to run(). - @param handle Must be passed to @p respond if it is called. - @param size The size of @p data. + @param handle Must be passed to `respond` if it is called. + @param size The size of `data`. @param data Data from run(), or NULL. */ LV2_Worker_Status (*work)(LV2_Handle instance, @@ -92,7 +92,7 @@ typedef struct _LV2_Worker_Interface { run() context when a response from the worker is ready. @param instance The LV2 instance this is a method on. - @param size The size of @p body. + @param size The size of `body`. @param body Message body, or NULL. */ LV2_Worker_Status (*work_response)(LV2_Handle instance, @@ -138,12 +138,12 @@ typedef struct _LV2_Worker_Schedule { immediately, and responses from the worker are delivered immediately, the effect of the work takes place immediately with sample accuracy. - The @p data MUST be safe for the host to copy and later pass to work(), + The `data` MUST be safe for the host to copy and later pass to work(), and the host MUST guarantee that it will be eventually passed to work() if this function returns LV2_WORKER_SUCCESS. @param handle The handle field of this struct. - @param size The size of @p data. + @param size The size of `data`. @param data Message to pass to work(), or NULL. */ LV2_Worker_Status (*schedule_work)(LV2_Worker_Schedule_Handle handle, |