clap

commit 4abea7523a9cf080746ccce59a718c5b881bd1d8
parent 48c39552dbbd5248e129d810f1b0783f144ddccd
Author: Paul Walker <paul@pwjw.com>
Date:   Mon, 20 Jun 2022 10:01:25 -0400

entry.h: Clarify recursion stopping points

Clarify the .clap file type on OS as bundle vs directory
and subsequent host stopping behavior

Diffstat:
M
include/clap/entry.h
 | 
6
++++--

1 file changed, 4 insertions(+), 2 deletions(-)
diff --git a/include/clap/entry.h b/include/clap/entry.h
@@ -29,9 +29,11 @@ extern "C" {
 // of this writing).
 //
 // Each directory should be recursively searched for files and/or bundles as appropriate in your OS
-// ending with the extension `.clap`.
+// 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 regular files or symlinks. On macOS
+// the '.clap' file is a bundle, so traversing the path should stop at directories.
 //
-// Every methods must be thread-safe.
+// Every method must be thread-safe.
 typedef struct clap_plugin_entry {
    clap_version_t clap_version; // initialized to CLAP_VERSION