diff options
| author | David Robillard <d@drobilla.net> | 2012-04-14 18:30:41 +0000 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2012-04-14 18:30:41 +0000 |
| commit | 528efbe23419c468c17f2244b1f82c1342ca7f3c (patch) | |
| tree | f1612593f0701716f37cf2fa6d2408d1e47779c2 | |
| parent | f32b297bf39a06b92e33069611cdaf17ee847c8a (diff) | |
| download | lv2-528efbe23419c468c17f2244b1f82c1342ca7f3c.tar.xz | |
Improve documentation.
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/log/log.h | 10 | ||||
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/log/log.ttl | 8 |
2 files changed, 9 insertions, 9 deletions
diff --git a/lv2/lv2plug.in/ns/ext/log/log.h b/lv2/lv2plug.in/ns/ext/log/log.h index 3c2ec40..8521ea8 100644 --- a/lv2/lv2plug.in/ns/ext/log/log.h +++ b/lv2/lv2plug.in/ns/ext/log/log.h @@ -59,7 +59,7 @@ typedef struct _LV2_Log { /** Opaque pointer to host data. - This MUST be passed to methods in this struct henever they are called. + This MUST be passed to methods in this struct whenever they are called. Otherwise, it must not be interpreted in any way. */ LV2_Log_Handle handle; @@ -67,10 +67,10 @@ typedef struct _LV2_Log { /** Log a message, passing format parameters directly. - The API of this function matches that of the standard C printf - function, except for the addition of the first two parameters. This - function may be called from any non-realtime context, or from any - context if @p type is @ref LV2_LOG__Trace. + The API of this function matches that of the standard C printf function, + except for the addition of the first two parameters. This function may + be called from any non-realtime context, or from any context if @p type + is @ref LV2_LOG__Trace. */ LV2_LOG_FUNC(3, 4) int (*printf)(LV2_Log_Handle handle, diff --git a/lv2/lv2plug.in/ns/ext/log/log.ttl b/lv2/lv2plug.in/ns/ext/log/log.ttl index 7d897d6..7c32466 100644 --- a/lv2/lv2plug.in/ns/ext/log/log.ttl +++ b/lv2/lv2plug.in/ns/ext/log/log.ttl @@ -20,10 +20,10 @@ messages with an API much like the standard C printf functions. This allows, for example, plugin logs to be nicely presented to the user in a graphical user interface.</p> -<p>Different log <q>levels</q> (e.g. <q>error</q> or <q>information</q>) are -defined by URI and passed as an LV2_URID. Thus, the possible number of log -levels is unlimited, but implementations SHOULD use the levels defined in this -extension unless they have a special reason to do otherwise.</p> +<p>Different log levels (e.g. <q>error</q> or <q>information</q>) are defined +by URI and passed as an LV2_URID. This document defines the typical levels +which should be sufficient, but implementations may define and use additional +levels to suit their needs.</p> """ . log:Entry |