From a27b62c0db1498eea8a2bea6deabd256b275bccb Mon Sep 17 00:00:00 2001
From: Teddy Wing
Date: Thu, 27 Oct 2022 02:44:57 +0200
Subject: SSVLSystemAlertVolume.h: Add function documentation

---
 SSVLSystemAlertVolume.h | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

(limited to 'SSVLSystemAlertVolume.h')

diff --git a/SSVLSystemAlertVolume.h b/SSVLSystemAlertVolume.h
index 3bf1bc7..8f9cfc5 100644
--- a/SSVLSystemAlertVolume.h
+++ b/SSVLSystemAlertVolume.h
@@ -4,11 +4,18 @@
 #include <AudioToolbox/AudioToolbox.h>
 #include <CoreFoundation/CoreFoundation.h>
 
-// TODO: docs
-// Float between 0 an 1.
+// Get the system alert volume.
+//
+// Sets `volume` to the current system alert volume.
+//
+// Returns the result of `AudioServicesGetProperty`.
 OSStatus SSVLGetSystemVolume(Float32 *volume);
 
-// TODO: docs
+// Set the system alert volume.
+//
+// The input `volume` must be a float between 0 an 1.
+//
+// Returns the result of `AudioServicesSetProperty`.
 OSStatus SSVLSetSystemVolume(Float32 volume);
 
 #endif /* SSVLSystemAlertVolume_h */
-- 
cgit v1.2.3