[asterisk-commits] mmichelson: branch mmichelson/sip_endpoint_reorg r395551 - /team/mmichelson/s...

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Fri Jul 26 14:26:52 2013
New Revision: 395551

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=395551
Log:
Add doxygen.

It's not much, but then again there are only so many ways
of saying "configuration options for X".


Modified:
    team/mmichelson/sip_endpoint_reorg/include/asterisk/res_sip.h

Modified: team/mmichelson/sip_endpoint_reorg/include/asterisk/res_sip.h
URL: http://svnview.digium.com/svn/asterisk/team/mmichelson/sip_endpoint_reorg/include/asterisk/res_sip.h?view=diff&rev=395551&r1=395550&r2=395551
==============================================================================
--- team/mmichelson/sip_endpoint_reorg/include/asterisk/res_sip.h (original)
+++ team/mmichelson/sip_endpoint_reorg/include/asterisk/res_sip.h Fri Jul 26 14:26:52 2013
@@ -337,6 +337,9 @@
 	struct ast_sip_timer_options timer;
 };
 
+/*!
+ * \brief Endpoint configuration for unsolicited MWI
+ */
 struct ast_sip_mwi_configuration {
 	AST_DECLARE_STRING_FIELDS(
 		/*! Configured voicemail boxes for this endpoint. Used for MWI */
@@ -348,6 +351,9 @@
 	unsigned int aggregate;
 };
 
+/*!
+ * \brief Endpoint subscription configuration
+ */
 struct ast_sip_endpoint_subscription_configuration {
 	/*! Indicates if endpoint is allowed to initiate subscriptions */
 	unsigned int allow;
@@ -357,6 +363,9 @@
 	struct ast_sip_mwi_configuration mwi;
 };
 
+/*!
+ * \brief NAT configuration options for endpoints
+ */
 struct ast_sip_endpoint_nat_configuration {
 	/*! Whether to force using the source IP address/port for sending responses */
 	unsigned int force_rport;
@@ -364,6 +373,11 @@
 	unsigned int rewrite_contact;
 };
 
+/*!
+ * \brief Party identification options for endpoints
+ *
+ * This includes caller ID, connected line, and redirecting-related options
+ */
 struct ast_sip_endpoint_id_configuration {
 	struct ast_party_id self;
 	/*! Do we accept identification information from this endpoint */
@@ -380,6 +394,9 @@
 	enum ast_sip_session_refresh_method refresh_method;
 };
 
+/*!
+ * \brief Call pickup configuration options for endpoints
+ */
 struct ast_sip_endpoint_pickup_configuration {
 	/*! Call group */
 	ast_group_t callgroup;
@@ -391,6 +408,9 @@
 	struct ast_namedgroups *named_pickupgroups;
 };
 
+/*!
+ * \brief Configuration for one-touch INFO recording
+ */
 struct ast_sip_info_recording_configuration {
 	AST_DECLARE_STRING_FIELDS(
 		/*! Feature to enact when one-touch recording INFO with Record: On is received */
@@ -402,11 +422,17 @@
 	unsigned int enabled;
 };
 
+/*!
+ * \brief Endpoint configuration options for INFO packages
+ */
 struct ast_sip_endpoint_info_configuration {
 	/*! Configuration for one-touch recording */
 	struct ast_sip_info_recording_configuration recording;
 };
 
+/*!
+ * \brief RTP configuration for SIP endpoints
+ */
 struct ast_sip_media_rtp_configuration {
 	AST_DECLARE_STRING_FIELDS(
 		/*! Configured RTP engine for this endpoint. */
@@ -430,6 +456,9 @@
 	enum ast_sip_session_media_encryption encryption;
 };
 
+/*!
+ * \brief Direct media options for SIP endpoints
+ */
 struct ast_sip_direct_media_configuration {
 	/*! Boolean indicating if direct_media is permissible */
 	unsigned int enabled;
@@ -441,7 +470,9 @@
 	unsigned int disable_on_nat;
 };
 
-
+/*!
+ * \brief Media configuration for SIP endpoints
+ */
 struct ast_sip_endpoint_media_configuration {
 	AST_DECLARE_STRING_FIELDS(
 		/*! Optional external media address to use in SDP */
@@ -468,6 +499,7 @@
 	/*! Priority for video streams */
 	unsigned int cos_video;
 };
+
 /*!
  * \brief An entity with which Asterisk communicates
  */
@@ -497,11 +529,15 @@
 	struct ast_sip_endpoint_extensions extensions;
 	/*! Configuration relating to media */
 	struct ast_sip_endpoint_media_configuration media;
+	/*! SUBSCRIBE/NOTIFY configuration options */
 	struct ast_sip_endpoint_subscription_configuration subscription;
+	/*! NAT configuration */
 	struct ast_sip_endpoint_nat_configuration nat;
+	/*! Party identification options */
 	struct ast_sip_endpoint_id_configuration id;
 	/*! Configuration options for INFO packages */
 	struct ast_sip_endpoint_info_configuration info;
+	/*! Call pickup configuration */
 	struct ast_sip_endpoint_pickup_configuration pickup;
 	/*! Inbound authentication credentials */
 	struct ast_sip_auth_array inbound_auths;