Changeset 2875 for pjproject/trunk


Ignore:
Timestamp:
Aug 13, 2009 3:57:26 PM (15 years ago)
Author:
bennylp
Message:

Misc (#915):

  • updated missing doxygen documentation from various PJMEDIA-CODEC headers
Location:
pjproject/trunk/pjmedia/include
Files:
13 edited

Legend:

Unmodified
Added
Removed

  • pjproject/trunk/pjmedia/include/pjmedia-codec/amr_helper.h

    r2506 r2875  
    3434/** 
    3535 * @defgroup PJMED_AMR_CODEC_HELPER AMR Codec Helper 
    36  * @ingroup PJMEDIA_CODEC 
     36 * @ingroup PJMEDIA_CODEC_CODECS 
    3737 * @brief AMR common tables and helper functions. 
    3838 * @{ 

  • pjproject/trunk/pjmedia/include/pjmedia-codec/config.h

    r2763 r2875  
    2121#define __PJMEDIA_CODEC_CONFIG_H__ 
    2222 
     23/** 
     24 * @file config.h 
     25 * @brief PJMEDIA-CODEC compile time settings 
     26 */ 
     27 
     28/** 
     29 * @defgroup pjmedia_codec_config PJMEDIA-CODEC Compile Time Settings 
     30 * @ingroup PJMEDIA_CODEC 
     31 * @brief Various compile time settings such as to enable/disable codecs 
     32 * @{ 
     33 */ 
     34 
    2335#include <pjmedia/types.h> 
     36 
    2437 
    2538/* 
    … …  
    204217#endif 
    205218 
     219/** 
     220 * Enable AMR passthrough codec. 
     221 * 
     222 * Default: 1 
     223 */ 
    206224#ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_AMR 
    207225#   define PJMEDIA_HAS_PASSTHROUGH_CODEC_AMR    1 
    208226#endif 
    209227 
     228/** 
     229 * Enable G.729 passthrough codec. 
     230 * 
     231 * Default: 1 
     232 */ 
    210233#ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_G729 
    211234#   define PJMEDIA_HAS_PASSTHROUGH_CODEC_G729   1 
    212235#endif 
    213236 
     237/** 
     238 * Enable iLBC passthrough codec. 
     239 * 
     240 * Default: 1 
     241 */ 
    214242#ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_ILBC 
    215243#   define PJMEDIA_HAS_PASSTHROUGH_CODEC_ILBC   1 
    216244#endif 
    217245 
     246/** 
     247 * Enable PCMU passthrough codec. 
     248 * 
     249 * Default: 1 
     250 */ 
    218251#ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_PCMU 
    219252#   define PJMEDIA_HAS_PASSTHROUGH_CODEC_PCMU   1 
    220253#endif 
    221254 
     255/** 
     256 * Enable PCMA passthrough codec. 
     257 * 
     258 * Default: 1 
     259 */ 
    222260#ifndef PJMEDIA_HAS_PASSTHROUGH_CODEC_PCMA 
    223261#   define PJMEDIA_HAS_PASSTHROUGH_CODEC_PCMA   1 
    … …  
    272310#endif 
    273311 
     312/** 
     313 * @} 
     314 */ 
     315 
    274316#endif  /* __PJMEDIA_CODEC_CONFIG_H__ */ 

  • pjproject/trunk/pjmedia/include/pjmedia-codec/g722.h

    r2394 r2875  
    3030/** 
    3131 * @defgroup PJMED_G722 G.722 Codec 
    32  * @ingroup PJMEDIA_CODEC 
     32 * @ingroup PJMEDIA_CODEC_CODECS 
    3333 * @brief Implementation of G.722 Codec 
    3434 * @{ 

  • pjproject/trunk/pjmedia/include/pjmedia-codec/g7221.h

    r2620 r2875  
    3030/** 
    3131 * @defgroup PJMED_G7221_CODEC G722.1 Codec 
    32  * @ingroup PJMEDIA_CODEC 
     32 * @ingroup PJMEDIA_CODEC_CODECS 
    3333 * @brief Implementation of G722.1 codec 
    3434 * @{ 

  • pjproject/trunk/pjmedia/include/pjmedia-codec/gsm.h

    r2394 r2875  
    3030/** 
    3131 * @defgroup PJMED_GSM GSM 06.10 Codec 
    32  * @ingroup PJMEDIA_CODEC 
     32 * @ingroup PJMEDIA_CODEC_CODECS 
    3333 * @brief Implementation of GSM FR based on GSM 06.10 library 
    3434 * @{ 

  • pjproject/trunk/pjmedia/include/pjmedia-codec/ilbc.h

    r2394 r2875  
    3030/** 
    3131 * @defgroup PJMED_ILBC iLBC Codec 
    32  * @ingroup PJMEDIA_CODEC 
     32 * @ingroup PJMEDIA_CODEC_CODECS 
    3333 * @brief Implementation of iLBC Codec 
    3434 * @{ 

  • pjproject/trunk/pjmedia/include/pjmedia-codec/ipp_codecs.h

    r2394 r2875  
    3030/** 
    3131 * @defgroup PJMED_IPP_CODEC IPP Codecs 
    32  * @ingroup PJMEDIA_CODEC 
     32 * @ingroup PJMEDIA_CODEC_CODECS 
    3333 * @brief Implementation of IPP codecs 
    3434 * @{ 

  • pjproject/trunk/pjmedia/include/pjmedia-codec/l16.h

    r2394 r2875  
    2626/** 
    2727 * @defgroup PJMED_L16 L16 Codec Family 
    28  * @ingroup PJMEDIA_CODEC 
     28 * @ingroup PJMEDIA_CODEC_CODECS 
    2929 * @brief PCM/16bit/linear codecs 
    3030 * @{ 

  • pjproject/trunk/pjmedia/include/pjmedia-codec/passthrough.h

    r2834 r2875  
    3030/** 
    3131 * @defgroup PJMED_PASSTHROUGH_CODEC Passthrough Codecs 
    32  * @ingroup PJMEDIA_CODEC 
     32 * @ingroup PJMEDIA_CODEC_CODECS 
    3333 * @brief Implementation of passthrough codecs 
    3434 * @{ 

  • pjproject/trunk/pjmedia/include/pjmedia-codec/speex.h

    r2394 r2875  
    3030/** 
    3131 * @defgroup PJMED_SPEEX Speex Codec Family 
    32  * @ingroup PJMEDIA_CODEC 
     32 * @ingroup PJMEDIA_CODEC_CODECS 
    3333 * @brief Implementation of Speex codecs (narrow/wide/ultrawide-band). 
    3434 * @{ 

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

    r2563 r2875  
    2121#define __PJMEDIA_CODEC_TYPES_H__ 
    2222 
     23/** 
     24 * @file types.h 
     25 * @brief PJMEDIA-CODEC types and constants 
     26 */ 
     27 
    2328#include <pjmedia-codec/config.h> 
     29 
     30/** 
     31 * @defgroup pjmedia_codec_types PJMEDIA-CODEC Types and Constants 
     32 * @ingroup PJMEDIA_CODEC 
     33 * @brief Constants used by PJMEDIA-CODEC 
     34 * @{ 
     35 */ 
     36 
     37 
    2438 
    2539/** 
    … …  
    7286}; 
    7387 
     88/** 
     89 * @} 
     90 */ 
    7491 
    7592 

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

    r2506 r2875  
    860860 */ 
    861861 
     862/** 
     863 * @defgroup PJMEDIA_CODEC_CODECS Supported codecs 
     864 * @ingroup PJMEDIA_CODEC 
     865 * @brief Documentation about individual codec supported by PJMEDIA 
     866 * @{ 
     867 * Please see the APIs provided by the individual codecs below. 
     868 */ 
     869/** 
     870 * @} 
     871 */ 
     872 
     873 
     874 
     875 
    862876PJ_END_DECL 
    863877 

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

    r2394 r2875  
    2929 
    3030/** 
    31  * @defgroup PJMED_G711 G711 
    32  * @ingroup PJMEDIA_CODEC 
     31 * @defgroup PJMED_G711 G711 G.711 Codec 
     32 * @ingroup PJMEDIA_CODEC_CODECS 
    3333 * @brief Standard G.711/PCMA and PCMU codec. 
    3434 * @{ 
Note: See TracChangeset for help on using the changeset viewer.