clap

commit b805ae3cdf3a2c6606bc65760e0dab7df03b49ca
parent 3a153864142fee2701b2a11026b1a41a488a1206
Author: Alexandre Bique <bique.alexandre@gmail.com>
Date:   Tue, 28 Jun 2022 15:18:43 +0200

Merge pull request #113 from baconpaul/entry-recursion

entry.h: Clarify recursion stopping points
Diffstat:
M
include/clap/entry.h
 | 
5
+++++

1 file changed, 5 insertions(+), 0 deletions(-)
diff --git a/include/clap/entry.h b/include/clap/entry.h
@@ -31,6 +31,11 @@ extern "C" {
 // Each directory should be recursively searched for files and/or bundles as appropriate in your OS
 // ending with the extension `.clap`.
 //
+// On Windows and Linux, the '.clap' file is a renamed shared library object, so traversing the path
+// should stop at the first non-directory (regular file, symlink, etc...) whose name ends in '.clap'.
+// On macOS the '.clap' file is a bundle, so traversing the path should stop at directories whose
+// name ends in '.clap'.
+//
 // Every method must be thread-safe.
 typedef struct clap_plugin_entry {
    clap_version_t clap_version; // initialized to CLAP_VERSION