[asterisk-commits] mmichelson: branch mmichelson/subscription_abstraction r416649 - /team/mmiche...

[SVN commits to the Asterisk project]

Author: mmichelson
Date: Wed Jun 18 14:17:07 2014
New Revision: 416649

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=416649
Log:
Add documentation where it was lacking in new API calls.


Modified:
    team/mmichelson/subscription_abstraction/include/asterisk/res_pjsip_pubsub.h

Modified: team/mmichelson/subscription_abstraction/include/asterisk/res_pjsip_pubsub.h
URL: http://svnview.digium.com/svn/asterisk/team/mmichelson/subscription_abstraction/include/asterisk/res_pjsip_pubsub.h?view=diff&rev=416649&r1=416648&r2=416649
==============================================================================
--- team/mmichelson/subscription_abstraction/include/asterisk/res_pjsip_pubsub.h (original)
+++ team/mmichelson/subscription_abstraction/include/asterisk/res_pjsip_pubsub.h Wed Jun 18 14:17:07 2014
@@ -339,14 +339,45 @@
  */
 int ast_sip_subscription_notify(struct ast_sip_subscription *sub, void *notify_data, int terminate);
 
-/*! Retrieve the local URI for this subscription */
+/*!
+ * \brief Retrieve the local URI for this subscription
+ *
+ * This is the local URI as determined by the underlying SIP dialog.
+ *
+ * \param sub The subscription
+ * \param[out] buf The buffer into which to store the URI.
+ * \param size The size of the buffer.
+ */
 void ast_sip_subscription_get_local_uri(struct ast_sip_subscription *sub, char *buf, size_t size);
  
-/*! Retrive the remote URI for this subscription */
+/*!
+ * \brief Retrive the remote URI for this subscription
+ *
+ * This is the remote URI as determined by the underlying SIP dialog.
+ *
+ * \param sub The subscription
+ * \param[out] buf The buffer into which to store the URI.
+ * \param size The size of the buffer.
+ */
 void ast_sip_subscription_get_remote_uri(struct ast_sip_subscription *sub, char *buf, size_t size);
 
+/*!
+ * \brief Get the name of the subscribed resource.
+ */
 const char *ast_sip_subscription_get_resource_name(struct ast_sip_subscription *sub);
 
+/*!
+ * \brief Get a header value for a subscription.
+ *
+ * For notifiers, the headers of the inbound SUBSCRIBE that started the dialog
+ * are stored on the subscription. This method allows access to the header. The
+ * return is the same as pjsip_msg_find_hdr_by_name(), meaning that it is dependent
+ * on the header being searched for.
+ * 
+ * \param sub The subscription to search in.
+ * \param header The name of the header to search for.
+ * \return The discovered header, or NULL if the header cannot be found.
+ */
 void *ast_sip_subscription_get_header(const struct ast_sip_subscription *sub, const char *header);
 
 /*!