summaryrefslogtreecommitdiff
path: root/libs/pbd/pbd/search_path.h
diff options
context:
space:
mode:
Diffstat (limited to 'libs/pbd/pbd/search_path.h')
-rw-r--r--libs/pbd/pbd/search_path.h16
1 files changed, 14 insertions, 2 deletions
diff --git a/libs/pbd/pbd/search_path.h b/libs/pbd/pbd/search_path.h
index 18f05ef014..e51d5de4ad 100644
--- a/libs/pbd/pbd/search_path.h
+++ b/libs/pbd/pbd/search_path.h
@@ -53,14 +53,26 @@ public:
SearchPath ();
/**
- * Initialize SearchPath from a string each path may or may not
- * exist.
+ * Initialize SearchPath from a string where the string contains
+ * one or more absolute paths to directories which are delimited
+ * by a path separation character. The path delimeter is a
+ * colon(:) on unix and a semi-colon(;) on windows.
+ *
+ * Each path contained in the search path may or may not resolve to
+ * an existing directory in the filesystem.
*
* @param search_path A path string.
*/
SearchPath (const string& search_path);
/**
+ * Initialize SearchPath from a sys::path.
+ *
+ * @param directory_path A directory path.
+ */
+ SearchPath (const sys::path& directory_path);
+
+ /**
* Initialize SearchPath from a vector of paths that may or may
* not exist.
*