Ignore:
Timestamp:
Jun 18, 2006 2:02:36 AM (18 years ago)
Author:
bennylp
Message:

Updated doxygen documentation to all headers in PJMEDIA

File:
1 edited

Legend:

Unmodified
Added
Removed

  • pjproject/trunk/pjmedia/include/pjmedia/types.h

    r513 r518  
    2020#define __PJMEDIA_TYPES_H__ 
    2121 
     22/** 
     23 * @file pjmedia/types.h Basic Types 
     24 * @brief Basic PJMEDIA types. 
     25 */ 
     26 
    2227#include <pjmedia/config.h> 
    2328#include <pj/sock.h>        /* pjmedia_sock_info        */ 
    … …  
    2530 
    2631 
     32/** 
     33 * @defgroup PJMEDIA_FRAME_OP Frame Operations 
     34 * @ingroup PJMEDIA 
     35 */ 
     36 
     37/** 
     38 * @defgroup PJMEDIA_MISC Misc 
     39 * @ingroup PJMEDIA 
     40 */ 
     41 
     42/** 
     43 * @defgroup PJMEDIA_TYPES Basic Types 
     44 * @ingroup PJMEDIA_BASE 
     45 * @brief Basic PJMEDIA types and operations. 
     46 * @{ 
     47 */ 
     48 
    2749/**  
    2850 * Top most media type.  
    2951 */ 
    30 enum pjmedia_type 
     52typedef enum pjmedia_type 
    3153{ 
    3254    /** No type. */ 
    … …  
    4466    PJMEDIA_TYPE_UNKNOWN = 3, 
    4567 
    46 }; 
    47  
    48 /** 
    49  * @see pjmedia_type 
    50  */ 
    51 typedef enum pjmedia_type pjmedia_type; 
     68} pjmedia_type; 
    5269 
    5370 
    … …  
    5673 * Media direction.  
    5774 */ 
    58 enum pjmedia_dir 
     75typedef enum pjmedia_dir 
    5976{ 
    6077    /** None */ 
    … …  
    7087    PJMEDIA_DIR_ENCODING_DECODING = 3, 
    7188 
    72 }; 
    73  
    74 /** 
    75  * @see pjmedia_dir 
    76  */ 
    77 typedef enum pjmedia_dir pjmedia_dir; 
     89} pjmedia_dir; 
     90 
    7891 
    7992 
    … …  
    96109 
    97110 
     111/** 
     112 * Create 32bit port signature from ASCII characters. 
     113 */ 
     114#define PJMEDIA_PORT_SIGNATURE(a,b,c,d)     \ 
     115            (a<<24 | b<<16 | c<<8 | d) 
     116 
     117 
    98118/**  
    99119 * Opague declaration of media endpoint.  
    … …  
    102122 
    103123 
    104 /**  
    105  * Media socket info.  
     124/* 
     125 * Forward declaration for stream (needed by transport). 
     126 */ 
     127typedef struct pjmedia_stream pjmedia_stream; 
     128 
     129 
     130/**  
     131 * Media socket info is used to describe the underlying sockets 
     132 * to be used as media transport. 
    106133 */ 
    107134typedef struct pjmedia_sock_info 
    108135{ 
    109  
    110     pj_sock_t       rtp_sock;       /**< Socket for RTP.                    */ 
    111     pj_sockaddr_in  rtp_addr_name;  /**< Local RTP address to be advertised.*/ 
    112     pj_sock_t       rtcp_sock;      /**< Socket for RTCP.                   */ 
    113     pj_sockaddr_in  rtcp_addr_name; /**< Local RTCP addr to be advertised.  */ 
     136    /** The RTP socket handle */ 
     137    pj_sock_t       rtp_sock; 
     138 
     139    /** Address to be advertised as the local address for the RTP 
     140     *  socket, which does not need to be equal as the bound 
     141     *  address (for example, this address can be the address resolved 
     142     *  with STUN). 
     143     */ 
     144    pj_sockaddr_in  rtp_addr_name; 
     145 
     146    /** The RTCP socket handle. */ 
     147    pj_sock_t       rtcp_sock; 
     148 
     149    /** Address to be advertised as the local address for the RTCP 
     150     *  socket, which does not need to be equal as the bound 
     151     *  address (for example, this address can be the address resolved 
     152     *  with STUN). 
     153     */ 
     154    pj_sockaddr_in  rtcp_addr_name; 
    114155 
    115156} pjmedia_sock_info; 
    … …  
    163204 
    164205 
     206/** 
     207 * @} 
     208 */ 
     209 
     210 
    165211#endif  /* __PJMEDIA_TYPES_H__ */ 
    166212 
Note: See TracChangeset for help on using the changeset viewer.