Changeset 7ad4142335ef48518a8aeceeddaba608f075fcc1

Show
Ignore:
Timestamp:
10/03/08 19:50:28 (7 months ago)
Author:
Rémi Duraffort <ivoire@videolan.org>
git-committer:
Rémi Duraffort <ivoire@videolan.org> 1205175028 +0100
git-parent:

[0b446e7833cf8c16602768951aac888938081718]

git-author:
Rémi Duraffort <ivoire@videolan.org> 1205175028 +0100
Message:

Use the same comments covention

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • src/interface/interaction.c

    r55b3628 r7ad4142  
    5959/** 
    6060 * Destroy the interaction system 
     61 * 
    6162 * \param The interaction object to destroy 
    6263 * \return nothing 
    …… 
    180181        va_end( args ); 
    181182 
    182 /** Send an error message, both in a blocking and non-blocking way 
    183  *  \param p_this     Parent vlc_object 
    184  *  \param b_blocking Is this dialog blocking or not? 
    185  *  \param psz_title  Title for the dialog 
    186  *  \param psz_format The message to display 
    187  *  */ 
     183/** 
     184 * Send an error message, both in a blocking and non-blocking way 
     185 * 
     186 * \param p_this     Parent vlc_object 
     187 * \param b_blocking Is this dialog blocking or not? 
     188 * \param psz_title  Title for the dialog 
     189 * \param psz_format The message to display 
     190 * \return           VLC_SUCCESS or VLC_EGENERIC 
     191 */ 
    188192int __intf_UserFatal( vlc_object_t *p_this, vlc_bool_t b_blocking, 
    189193                       const char *psz_title, 
    …… 
    204208} 
    205209 
    206 /** Helper function to send an warning, which is always shown non-blocking 
    207  *  \param p_this     Parent vlc_object 
    208  *  \param psz_title  Title for the dialog 
    209  *  \param psz_format The message to display 
    210  *  */ 
     210/** 
     211 * Helper function to send a warning, which is always shown non-blocking 
     212 * 
     213 * \param p_this     Parent vlc_object 
     214 * \param psz_title  Title for the dialog 
     215 * \param psz_format The message to display 
     216 * \return           VLC_SUCCESS or VLC_EGENERIC 
     217 */ 
    211218int __intf_UserWarn( vlc_object_t *p_this, 
    212219                     const char *psz_title, 
    …… 
    224231} 
    225232 
    226 /** Helper function to ask a yes-no-cancel question 
    227  *  \param p_this           Parent vlc_object 
    228  *  \param psz_title        Title for the dialog 
    229  *  \param psz_description  A description 
    230  *  \param psz_default      caption for the default button 
    231  *  \param psz_alternate    caption for the alternate button 
    232  *  \param psz_other        caption for the optional 3rd button (== cancel) 
    233  *  \return                 Clicked button code 
     233/** 
     234 * Helper function to ask a yes-no-cancel question 
     235 * 
     236 * \param p_this           Parent vlc_object 
     237 * \param psz_title        Title for the dialog 
     238 * \param psz_description  A description 
     239 * \param psz_default      caption for the default button 
     240 * \param psz_alternate    caption for the alternate button 
     241 * \param psz_other        caption for the optional 3rd button (== cancel) 
     242 * \return                 Clicked button code 
    234243 */ 
    235244int __intf_UserYesNo( vlc_object_t *p_this, 
    …… 
    253262} 
    254263 
    255 /** Helper function to create a dialogue showing a progress-bar with some info 
    256  *  \param p_this           Parent vlc_object 
    257  *  \param psz_title        Title for the dialog (NULL implies main intf ) 
    258  *  \param psz_status       Current status 
    259  *  \param f_position       Current position (0.0->100.0) 
    260  *  \param i_timeToGo       Time (in sec) to go until process is finished 
    261  *  \return                 Dialog id, to give to UserProgressUpdate 
     264/** 
     265 * Helper function to create a dialogue showing a progress-bar with some info 
     266 * 
     267 * \param p_this           Parent vlc_object 
     268 * \param psz_title        Title for the dialog (NULL implies main intf ) 
     269 * \param psz_status       Current status 
     270 * \param f_position       Current position (0.0->100.0) 
     271 * \param i_timeToGo       Time (in sec) to go until process is finished 
     272 * \return                 Dialog id, to give to UserProgressUpdate 
    262273 */ 
    263274int __intf_Progress( vlc_object_t *p_this, const char *psz_title, 
    …… 
    282293} 
    283294 
    284 /** Update a progress bar in a dialogue 
    285  *  \param p_this           Parent vlc_object 
    286  *  \param i_id             Identifier of the dialog 
    287  *  \param psz_status       New status 
    288  *  \param f_position       New position (0.0->100.0) 
    289  *  \param i_timeToGo       Time (in sec) to go until process is finished 
    290  *  \return                 nothing 
     295/** 
     296 * Update a progress bar in a dialogue 
     297 * 
     298 * \param p_this           Parent vlc_object 
     299 * \param i_id             Identifier of the dialog 
     300 * \param psz_status       New status 
     301 * \param f_position       New position (0.0->100.0) 
     302 * \param i_timeToGo       Time (in sec) to go until process is finished 
     303 * \return                 nothing 
    291304 */ 
    292305void __intf_ProgressUpdate( vlc_object_t *p_this, int i_id, 
    …… 
    319332} 
    320333 
    321 /** Helper function to communicate dialogue cancellations between the 
    322  *  interface module and the caller 
    323  *  \param p_this           Parent vlc_object 
    324  *  \param i_id             Identifier of the dialogue 
    325  *  \return                 Either true or false 
     334/** 
     335 * Helper function to communicate dialogue cancellations between the 
     336 * interface module and the caller 
     337 * 
     338 * \param p_this           Parent vlc_object 
     339 * \param i_id             Identifier of the dialogue 
     340 * \return                 Either true or false 
    326341 */ 
    327342vlc_bool_t __intf_UserProgressIsCancelled( vlc_object_t *p_this, int i_id ) 
    …… 
    346361} 
    347362 
    348 /** Helper function to make a login/password dialogue 
    349  *  \param p_this           Parent vlc_object 
    350  *  \param psz_title        Title for the dialog 
    351  *  \param psz_description  A description 
    352  *  \param ppsz_login       Returned login 
    353  *  \param ppsz_password    Returned password 
    354  *  \return                 Clicked button code 
     363/** 
     364 * Helper function to make a login/password dialogue 
     365 * 
     366 * \param p_this           Parent vlc_object 
     367 * \param psz_title        Title for the dialog 
     368 * \param psz_description  A description 
     369 * \param ppsz_login       Returned login 
     370 * \param ppsz_password    Returned password 
     371 * \return                 Clicked button code 
    355372 */ 
    356373int __intf_UserLoginPassword( vlc_object_t *p_this, 
    …… 
    382399} 
    383400 
    384 /** Helper function to make a dialogue asking the user for !password string 
    385  *  \param p_this           Parent vlc_object 
    386  *  \param psz_title        Title for the dialog 
    387  *  \param psz_description  A description 
    388  *  \param ppsz_usersString Returned login 
    389  *  \return                 Clicked button code 
     401/** 
     402 * Helper function to make a dialogue asking the user for !password string 
     403 * 
     404 * \param p_this           Parent vlc_object 
     405 * \param psz_title        Title for the dialog 
     406 * \param psz_description  A description 
     407 * \param ppsz_usersString Returned login 
     408 * \return                 Clicked button code 
    390409 */ 
    391410int __intf_UserStringInput( vlc_object_t *p_this, 
    …… 
    412431} 
    413432 
    414 /** Hide an interaction dialog 
     433/** 
     434 * Hide an interaction dialog 
     435 * 
    415436 * \param p_this the parent vlc object 
    416437 * \param i_id the id of the item to hide 
    …… 
    543564    if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT ) return VLC_EGENERIC; 
    544565 
    545     if( config_GetInt(p_this, "interact") || 
     566    if( config_GetInt( p_this, "interact" ) || 
    546567        p_dialog->i_flags & DIALOG_BLOCKING_ERROR || 
    547568        p_dialog->i_flags & DIALOG_NONBLOCKING_ERROR )