summaryrefslogtreecommitdiff
path: root/libs/ardour/ardour/session_directory.h
diff options
context:
space:
mode:
Diffstat (limited to 'libs/ardour/ardour/session_directory.h')
-rw-r--r--libs/ardour/ardour/session_directory.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/libs/ardour/ardour/session_directory.h b/libs/ardour/ardour/session_directory.h
index 131812c130..d23c135e0b 100644
--- a/libs/ardour/ardour/session_directory.h
+++ b/libs/ardour/ardour/session_directory.h
@@ -80,8 +80,15 @@ public:
bool is_valid () const;
/**
- * @return true If a new session directory and all the
- * subdirectories were created, otherwise false.
+ * Create the session directory and all the subdirectories.
+ *
+ * @throw PBD::sys::filesystem_error if the directories were
+ * not able to be created.
+ *
+ * @return true If a new session directory was created, otherwise
+ * (if it already existed) false.
+ *
+ * @post is_valid ()
*/
bool create ();