From 528efbe23419c468c17f2244b1f82c1342ca7f3c Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Sat, 14 Apr 2012 18:30:41 +0000
Subject: Improve documentation.
---
lv2/lv2plug.in/ns/ext/log/log.h | 10 +++++-----
lv2/lv2plug.in/ns/ext/log/log.ttl | 8 ++++----
2 files changed, 9 insertions(+), 9 deletions(-)
(limited to 'lv2')
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
--
cgit v1.2.1