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/clock.h

    r404 r518  
    2727 
    2828 
     29/** 
     30 * @addtogroup PJMEDIA_CLOCK Clock Generator 
     31 * @ingroup PJMEDIA_PORT_CLOCK 
     32 * @brief Interface for generating clock. 
     33 * @{ 
     34 *  
     35 * The clock generator provides the application with media timing, 
     36 * and it is used by the @ref PJMEDIA_MASTER_PORT for its sound clock. 
     37 * 
     38 * The clock generator may be configured to run <b>asynchronously</b>  
     39 * (the default behavior) or <b>synchronously</b>. When it is run  
     40 * asynchronously, it will call the application's callback every time 
     41 * the clock <b>tick</b> expires. When it is run synchronously,  
     42 * application must continuously polls the clock generator to synchronize 
     43 * the timing. 
     44 */ 
     45 
    2946PJ_BEGIN_DECL 
    3047 
    … …  
    3653 
    3754 
     55/** 
     56 * Options when creating the clock. 
     57 */ 
    3858enum pjmedia_clock_options 
    3959{ 
     60    /** 
     61     * Prevents the clock from running asynchronously. In this case, 
     62     * application must poll the clock continuously by calling 
     63     * #pjmedia_clock_wait() in order to synchronize timing. 
     64     */ 
    4065    PJMEDIA_CLOCK_NO_ASYNC  = 1, 
    4166}; 
     67 
    4268 
    4369/** 
    … …  
    138164PJ_END_DECL 
    139165 
     166/** 
     167 * @} 
     168 */ 
    140169 
    141170 
Note: See TracChangeset for help on using the changeset viewer.