Changeset 1110 for pjproject/trunk/pjnath/include/pjnath/stun_session.h

Timestamp:

Mar 27, 2007 11:29:27 PM (17 years ago)

Author:

bennylp

Message:

Created doxygen documentation for PJNATH

File:

• pjproject/trunk/pjnath/include/pjnath/stun_session.h (modified) (3 diffs)

pjproject/trunk/pjnath/include/pjnath/stun_session.h

@@ -19 +19 @@
 #ifndef __PJNATH_STUN_SESSION_H__
 #define __PJNATH_STUN_SESSION_H__
+
+/**
+ * @file stun_session.h
+ * @brief STUN session management for client/server.
+ */
 
 #include <pjnath/stun_msg.h>
@@ -188 +193 @@
  *
  * @param sess      The STUN session instance.
+ * @param user_data The user data.
  *
  * @return          PJ_SUCCESS on success, or the appropriate error code.
@@ -352 +358 @@
  * the message via one of the pj_stun_session_cb callback.
  *
- * @param sess       The STUN session instance.
- * @param packet     The packet containing STUN message.
- * @param pkt_size   Size of the packet.
- * @param options    Options, from #pj_stun_decode_options.
- * @param parsed_len Optional pointer to receive the size of the parsed
- *                   STUN message (useful if packet is received via a
- *                   stream oriented protocol).
- *
- * @return           PJ_SUCCESS on success, or the appropriate error code.
+ * @param sess          The STUN session instance.
+ * @param packet        The packet containing STUN message.
+ * @param pkt_size      Size of the packet.
+ * @param options       Options, from #pj_stun_decode_options.
+ * @param parsed_len    Optional pointer to receive the size of the parsed
+ *                      STUN message (useful if packet is received via a
+ *                      stream oriented protocol).
+ * @param src_addr      The source address of the packet.
+ * @param src_addr_len  Length of the source address.
+ *
+ * @return              PJ_SUCCESS on success, or the appropriate error code.
  */
 PJ_DECL(pj_status_t) pj_stun_session_on_rx_pkt(pj_stun_session *sess,