Changeset 2642 for pjproject/trunk/pjnath/include/pjnath/stun_sock.h

Timestamp:

Apr 22, 2009 5:20:24 PM (15 years ago)

Author:

bennylp

Message:

Part of ticket #780: enhance the PJNATH doxygen documentation

File:

• pjproject/trunk/pjnath/include/pjnath/stun_sock.h (modified) (7 diffs)

pjproject/trunk/pjnath/include/pjnath/stun_sock.h

@@ -35 +35 @@
 
 /**
- * @defgroup PJNATH_STUN_SOCK STUN aware socket transport
- * @brief STUN aware socket transport
- * @ingroup PJNATH_STUN
+ * @addtogroup PJNATH_STUN_SOCK
  * @{
  *
  * The STUN transport provides asynchronous UDP like socket transport
- * with the additional capability to query the publicly mapped transport
- * address (using STUN resolution), to refresh the NAT binding, and to
- * demultiplex internal STUN messages from application data (the 
- * application data may be a STUN message as well).
+ * with the additional STUN capability. It has the following features:
+ *
+ *  - API to send and receive UDP packets
+ *
+ *  - multiplex STUN and non-STUN incoming packets and distinguish between
+ *    STUN responses that belong to internal requests with application data
+ *    (the application data may be STUN packets as well)
+ *
+ *  - DNS SRV resolution to the STUN server (if wanted), along with fallback
+ *    to DNS A resolution if SRV record is not found.
+ *
+ *  - STUN keep-alive maintenance, and handle changes to the mapped address
+ *    (when the NAT binding changes)
+ *
  */
 
@@ -276 +284 @@
  * @param p_sock        Pointer to receive the created transport instance.
  *
- * @restun              PJ_SUCCESS if the operation has been successful,
+ * @return              PJ_SUCCESS if the operation has been successful,
  *                      or the appropriate error code on failure.
  */
@@ -328 +336 @@
  * @param sock          The STUN transport socket.
  *
- * @restun              PJ_SUCCESS if the operation has been successful,
+ * @return              PJ_SUCCESS if the operation has been successful,
  *                      or the appropriate error code on failure.
  */
@@ -341 +349 @@
  * @param user_data     Arbitrary data.
  *
- * @restun              PJ_SUCCESS if the operation has been successful,
+ * @return              PJ_SUCCESS if the operation has been successful,
  *                      or the appropriate error code on failure.
  */
@@ -353 +361 @@
  * @param stun_sock     The STUN transport instance.
  *
- * @restun              The user/application data.
+ * @return              The user/application data.
  */
 PJ_DECL(void*) pj_stun_sock_get_user_data(pj_stun_sock *stun_sock);
@@ -365 +373 @@
  * @param info          Pointer to be filled with STUN transport info.
  *
- * @restun              PJ_SUCCESS if the operation has been successful,
+ * @return              PJ_SUCCESS if the operation has been successful,
  *                      or the appropriate error code on failure.
  */
@@ -377 +385 @@
  *
  * @param stun_sock     The STUN transport instance.
- * @param op_key        Optional send key for sending the packet down to
+ * @param send_key      Optional send key for sending the packet down to
  *                      the ioqueue. This value will be given back to
  *                      \a on_data_sent() callback