From 078ff07e94e13e9dcfcda7c607b04332214a723d Mon Sep 17 00:00:00 2001
From: sletz <sletz@0c269be4-1314-0410-8aa9-9f06e86f4224>
Date: Wed, 22 Apr 2009 14:10:07 +0000
Subject: [PATCH] Add documentation for jackctl_server_add_slave,
 jackctl_server_remove_slave and jackctl_server_switch_master functions.

git-svn-id: http://subversion.jackaudio.org/jack/jack2/trunk/jackmp@3520 0c269be4-1314-0410-8aa9-9f06e86f4224
---
 common/jack/control.h | 26 +++++++++++++++++++++++++-
 1 file changed, 25 insertions(+), 1 deletion(-)

diff --git a/common/jack/control.h b/common/jack/control.h
index 9bc4a3e0..6761849b 100644
--- a/common/jack/control.h
+++ b/common/jack/control.h
@@ -510,14 +510,38 @@ jack_log(
 
 /* @} */
 
+/** 
+ * Call this function to add a slave in the backend slave list.
+ * 
+ * @param server server object handle
+ * @param driver driver to add in the backend slave list.
+ * 
+ * @return success status: true - success, false - fail
+ */ 
 bool 
 jackctl_server_add_slave(jackctl_server_t * server,
                             jackctl_driver_t * driver);
 
+/** 
+ * Call this function to remove a slave from the backend slave list.
+ * 
+ * @param server server object handle
+ * @param driver driver to remove from the backend slave list.
+ * 
+ * @return success status: true - success, false - fail
+ */ 
 bool 
 jackctl_server_remove_slave(jackctl_server_t * server,
                             jackctl_driver_t * driver);
-                            
+
+/** 
+ * Call this function to switch master backend.
+ * 
+ * @param server server object handle
+ * @param driver driver to switch to
+ * 
+ * @return success status: true - success, false - fail
+ */                          
 bool 
 jackctl_server_switch_master(jackctl_server_t * server,
                             jackctl_driver_t * driver);