From 2fcb9c82c015524f7282b77ecd91d9e1f8db76e9 Mon Sep 17 00:00:00 2001
From: David Robillard <d@drobilla.net>
Date: Fri, 5 Jan 2007 21:55:38 +0000
Subject: LV2 spec updates.

git-svn-id: http://svn.drobilla.net/lad/slv2@232 a436a847-0d15-0410-975c-d299462d15a1
---
 slv2/lv2.h | 16 ++++++++++------
 1 file changed, 10 insertions(+), 6 deletions(-)

(limited to 'slv2')

diff --git a/slv2/lv2.h b/slv2/lv2.h
index 51cb61a..3b182b1 100644
--- a/slv2/lv2.h
+++ b/slv2/lv2.h
@@ -34,7 +34,9 @@ extern "C" {
 /* ************************************************************************* */
 
 
-/* Overview: 
+/** @file lv2.h
+ *
+ * == Overview ==
  *
  * There are a large number of open source and free software synthesis
  * packages in use or development at this time. This API ('LV2')
@@ -67,10 +69,12 @@ extern "C" {
  * by dlopen() and family. The file will provide a number of 'plugin
  * types' that can be used to instantiate actual plugins (sometimes known
  * as 'plugin instances') that can be connected together to perform tasks.
+ * The host can access these plugin types using the lv2_descriptor() 
+ * function.
  *
  * This API contains very limited error-handling.
  *
- * Threading rules:
+ * == Threading rules ==
  *
  * Certain hosts may need to call the functions provided by a plugin from
  * multiple threads. For this to be safe, the plugin must be written so that
@@ -78,9 +82,9 @@ extern "C" {
  * To facilitate this, the functions provided by a plugin are divided into
  * classes:
  *
- * Audio class:           run(), connect_port()
- * Instantiation class:   instantiate(), cleanup(), 
- *                        activate(), deactivate()
+ *  - Audio class:           run(), connect_port()
+ *  - Instantiation class:   instantiate(), cleanup(), 
+ *                           activate(), deactivate()
  *
  * Extensions to this specification which add new functions MUST declare in
  * which of these classes the functions belong, or define new classes for them.
@@ -326,7 +330,7 @@ typedef struct _LV2_Descriptor {
 /* ****************************************************************** */
 
 
-/** Accessing a Plugin:
+/** Accessing Plugin Types.
  *
  * The exact mechanism by which plugins are loaded is host-dependent,
  * however all most hosts will need to know is the URI of the plugin they
-- 
cgit v1.2.1