Doc: somes details on user registration functions

diff --git a/src/include/switch_core.h b/src/include/switch_core.h
index 984b54fac72487efe4aa81108e4a95ecbc54927c..9505fe4c401cb01a618dd4cf766c367e54ed95ff 100644 (file)
--- a/src/include/switch_core.h
+++ b/src/include/switch_core.h
@@ -2227,9 +2227,33 @@ SWITCH_DECLARE(const char *) switch_core_banner(void);
 SWITCH_DECLARE(switch_bool_t) switch_core_session_in_thread(switch_core_session_t *session);
 SWITCH_DECLARE(uint32_t) switch_default_ptime(const char *name, uint32_t number);
 
+/*!
+ \brief Add user registration
+ \param [in] user
+ \param [in] realm
+ \param [in] token
+ \param [in] url - a freeswitch dial string
+ \param [in] expires
+ \param [in] network_ip
+ \param [in] network_port
+ \param [in] network_proto - one of tls, tcp, udp
+ \param [out] err - Error if it exists
+*/
 SWITCH_DECLARE(switch_status_t) switch_core_add_registration(const char *user, const char *realm, const char *token, const char *url, uint32_t expires, 
                                                                                                                         const char *network_ip, const char *network_port, const char *network_proto);
+/*!
+ \brief Delete user registration
+ \param [in] user
+ \param [in] realm
+ \param [in] token
+ \param [out] err - Error if it exists
+*/
 SWITCH_DECLARE(switch_status_t) switch_core_del_registration(const char *user, const char *realm, const char *token);
+/*!
+ \brief Expire user registrations
+ \param [in] force delete all registrations
+ \param [out] err - Error if it exists
+*/
 SWITCH_DECLARE(switch_status_t) switch_core_expire_registration(int force);
 
 SWITCH_END_EXTERN_C