clap

commit 88eace6987f421dde742a811fd403ffb16963386
parent a2c50bf7b754874a2a4e7dc1f099550af9fa5ea7
Author: Alexandre BIQUE <bique.alexandre@gmail.com>
Date:   Sun, 22 May 2022 11:09:49 +0200

Add documentation

Diffstat:
M
include/clap/ext/posix-fd-support.h
 | 
1
+
M
include/clap/plugin.h
 | 
6
++++--

2 files changed, 5 insertions(+), 2 deletions(-)
diff --git a/include/clap/ext/posix-fd-support.h b/include/clap/ext/posix-fd-support.h
@@ -2,6 +2,7 @@
 
 #include "../plugin.h"
 
+// This extension let your plugin hook itself into the host select/poll/epoll/kqueue reactor.
 static CLAP_CONSTEXPR const char CLAP_EXT_POSIX_FD_SUPPORT[] = "clap.posix-fd-support";
 
 #ifdef __cplusplus
diff --git a/include/clap/plugin.h b/include/clap/plugin.h
@@ -11,8 +11,10 @@ extern "C" {
 typedef struct clap_plugin_descriptor {
    clap_version_t clap_version; // initialized to CLAP_VERSION
 
-   const char *id;          // eg: "com.u-he.diva"
-   const char *name;        // eg: "Diva"
+   // Mandatory fields must be set and must not be blank.
+   // Otherwise the fields can be null or blank, though it is safer to make them blank.
+   const char *id;          // eg: "com.u-he.diva", mandatory
+   const char *name;        // eg: "Diva", mandatory
    const char *vendor;      // eg: "u-he"
    const char *url;         // eg: "https://u-he.com/products/diva/"
    const char *manual_url;  // eg: "https://dl.u-he.com/manuals/plugins/diva/Diva-user-guide.pdf"