[1704] Add note about exception thrown

diff --git a/src/lib/util/interprocess_sync_file.h b/src/lib/util/interprocess_sync_file.h
index 84016a6736e5608b3da23a822c529ba9ef19e58c..0c999299973667722acdd857d8df3a6dd987b519 100644 (file)
--- a/src/lib/util/interprocess_sync_file.h
+++ b/src/lib/util/interprocess_sync_file.h
@@ -38,6 +38,9 @@ public:
 /// interprocess synchronization mechanism. Please see the
 /// InterprocessSync class documentation for usage.
 ///
+/// An InterprocessSyncFileError exception may be thrown if there is an
+/// issue opening the lock file.
+///
 /// Lock files are created typically in the local state directory
 /// (var). They are typically named like "<task_name>_lockfile".
 /// This implementation opens lock files lazily (only when