Ignore:
Timestamp:
Apr 22, 2009 5:20:24 PM (10 years ago)
Author:
bennylp
Message:

Part of ticket #780: enhance the PJNATH doxygen documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • pjproject/trunk/pjnath/include/pjnath/stun_sock.h

    r2484 r2642  
    3535 
    3636/** 
    37  * @defgroup PJNATH_STUN_SOCK STUN aware socket transport 
    38  * @brief STUN aware socket transport 
    39  * @ingroup PJNATH_STUN 
     37 * @addtogroup PJNATH_STUN_SOCK 
    4038 * @{ 
    4139 * 
    4240 * The STUN transport provides asynchronous UDP like socket transport 
    43  * with the additional capability to query the publicly mapped transport 
    44  * address (using STUN resolution), to refresh the NAT binding, and to 
    45  * demultiplex internal STUN messages from application data (the  
    46  * application data may be a STUN message as well). 
     41 * with the additional STUN capability. It has the following features: 
     42 * 
     43 *  - API to send and receive UDP packets 
     44 * 
     45 *  - multiplex STUN and non-STUN incoming packets and distinguish between 
     46 *    STUN responses that belong to internal requests with application data 
     47 *    (the application data may be STUN packets as well) 
     48 * 
     49 *  - DNS SRV resolution to the STUN server (if wanted), along with fallback 
     50 *    to DNS A resolution if SRV record is not found. 
     51 * 
     52 *  - STUN keep-alive maintenance, and handle changes to the mapped address 
     53 *    (when the NAT binding changes) 
     54 * 
    4755 */ 
    4856 
     
    276284 * @param p_sock        Pointer to receive the created transport instance. 
    277285 * 
    278  * @restun              PJ_SUCCESS if the operation has been successful, 
     286 * @return              PJ_SUCCESS if the operation has been successful, 
    279287 *                      or the appropriate error code on failure. 
    280288 */ 
     
    328336 * @param sock          The STUN transport socket. 
    329337 * 
    330  * @restun              PJ_SUCCESS if the operation has been successful, 
     338 * @return              PJ_SUCCESS if the operation has been successful, 
    331339 *                      or the appropriate error code on failure. 
    332340 */ 
     
    341349 * @param user_data     Arbitrary data. 
    342350 * 
    343  * @restun              PJ_SUCCESS if the operation has been successful, 
     351 * @return              PJ_SUCCESS if the operation has been successful, 
    344352 *                      or the appropriate error code on failure. 
    345353 */ 
     
    353361 * @param stun_sock     The STUN transport instance. 
    354362 * 
    355  * @restun              The user/application data. 
     363 * @return              The user/application data. 
    356364 */ 
    357365PJ_DECL(void*) pj_stun_sock_get_user_data(pj_stun_sock *stun_sock); 
     
    365373 * @param info          Pointer to be filled with STUN transport info. 
    366374 * 
    367  * @restun              PJ_SUCCESS if the operation has been successful, 
     375 * @return              PJ_SUCCESS if the operation has been successful, 
    368376 *                      or the appropriate error code on failure. 
    369377 */ 
     
    377385 * 
    378386 * @param stun_sock     The STUN transport instance. 
    379  * @param op_key        Optional send key for sending the packet down to 
     387 * @param send_key      Optional send key for sending the packet down to 
    380388 *                      the ioqueue. This value will be given back to 
    381389 *                      \a on_data_sent() callback 
Note: See TracChangeset for help on using the changeset viewer.