diff options
| author | Kinsey Moore <kmoore@digium.com> | 2013-05-19 17:45:42 +0000 |
|---|---|---|
| committer | Kinsey Moore <kmoore@digium.com> | 2013-05-19 17:45:42 +0000 |
| commit | 1b5a3069f97661e4f00e56904d8bc546370c41b0 (patch) | |
| tree | 81701f6980b53a2882eeaf938aa84d81af41c0a1 /res/res_sip_endpoint_identifier_ip.c | |
| parent | b46840ae3e71f793971f83e5625cd7cded769f13 (diff) | |
Add base XML documentation for res_sip
Thanks to Brad Latus, this patch adds a significant amount much-needed
documentation to res_sip. It should cover all existing configuration
options currently in Asterisk trunk.
Patch-by: Brad Latus (snuffy)
Review: https://reviewboard.asterisk.org/r/2471/
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@389148 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'res/res_sip_endpoint_identifier_ip.c')
| -rw-r--r-- | res/res_sip_endpoint_identifier_ip.c | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/res/res_sip_endpoint_identifier_ip.c b/res/res_sip_endpoint_identifier_ip.c index e3630ad07..89bf1d554 100644 --- a/res/res_sip_endpoint_identifier_ip.c +++ b/res/res_sip_endpoint_identifier_ip.c @@ -30,6 +30,25 @@ #include "asterisk/module.h" #include "asterisk/acl.h" +/*** DOCUMENTATION + <configInfo name="res_sip_endpoint_identifier_ip" language="en_US"> + <synopsis>Module that identifies endpoints via source IP address</synopsis> + <configFile name="res_sip.conf"> + <configObject name="identify"> + <configOption name="endpoint"> + <synopsis>Name of Endpoint</synopsis> + </configOption> + <configOption name="match"> + <synopsis>IP addresses or networks to match against</synopsis> + </configOption> + <configOption name="type"> + <synopsis>Must be of type 'identify'.</synopsis> + </configOption> + </configObject> + </configFile> + </configInfo> + ***/ + /*! \brief Structure for an IP identification matching object */ struct ip_identify_match { /*! \brief Sorcery object details */ |