Commit 7ad41423 authored by Rémi Duraffort's avatar Rémi Duraffort

Use the same comments covention

parent 0b446e78
...@@ -58,6 +58,7 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog ); ...@@ -58,6 +58,7 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog );
/** /**
* Destroy the interaction system * Destroy the interaction system
*
* \param The interaction object to destroy * \param The interaction object to destroy
* \return nothing * \return nothing
*/ */
...@@ -179,12 +180,15 @@ void intf_InteractionManage( playlist_t *p_playlist ) ...@@ -179,12 +180,15 @@ void intf_InteractionManage( playlist_t *p_playlist )
vasprintf( &p_new->psz_description, psz_format, args ); \ vasprintf( &p_new->psz_description, psz_format, args ); \
va_end( args ); va_end( args );
/** Send an error message, both in a blocking and non-blocking way /**
* Send an error message, both in a blocking and non-blocking way
*
* \param p_this Parent vlc_object * \param p_this Parent vlc_object
* \param b_blocking Is this dialog blocking or not? * \param b_blocking Is this dialog blocking or not?
* \param psz_title Title for the dialog * \param psz_title Title for the dialog
* \param psz_format The message to display * \param psz_format The message to display
* */ * \return VLC_SUCCESS or VLC_EGENERIC
*/
int __intf_UserFatal( vlc_object_t *p_this, vlc_bool_t b_blocking, int __intf_UserFatal( vlc_object_t *p_this, vlc_bool_t b_blocking,
const char *psz_title, const char *psz_title,
const char *psz_format, ... ) const char *psz_format, ... )
...@@ -203,11 +207,14 @@ int __intf_UserFatal( vlc_object_t *p_this, vlc_bool_t b_blocking, ...@@ -203,11 +207,14 @@ int __intf_UserFatal( vlc_object_t *p_this, vlc_bool_t b_blocking,
return DialogSend( p_this, p_new ); return DialogSend( p_this, p_new );
} }
/** Helper function to send an warning, which is always shown non-blocking /**
* Helper function to send a warning, which is always shown non-blocking
*
* \param p_this Parent vlc_object * \param p_this Parent vlc_object
* \param psz_title Title for the dialog * \param psz_title Title for the dialog
* \param psz_format The message to display * \param psz_format The message to display
* */ * \return VLC_SUCCESS or VLC_EGENERIC
*/
int __intf_UserWarn( vlc_object_t *p_this, int __intf_UserWarn( vlc_object_t *p_this,
const char *psz_title, const char *psz_title,
const char *psz_format, ... ) const char *psz_format, ... )
...@@ -223,7 +230,9 @@ int __intf_UserWarn( vlc_object_t *p_this, ...@@ -223,7 +230,9 @@ int __intf_UserWarn( vlc_object_t *p_this,
return DialogSend( p_this, p_new ); return DialogSend( p_this, p_new );
} }
/** Helper function to ask a yes-no-cancel question /**
* Helper function to ask a yes-no-cancel question
*
* \param p_this Parent vlc_object * \param p_this Parent vlc_object
* \param psz_title Title for the dialog * \param psz_title Title for the dialog
* \param psz_description A description * \param psz_description A description
...@@ -252,7 +261,9 @@ int __intf_UserYesNo( vlc_object_t *p_this, ...@@ -252,7 +261,9 @@ int __intf_UserYesNo( vlc_object_t *p_this,
return DialogSend( p_this, p_new ); return DialogSend( p_this, p_new );
} }
/** Helper function to create a dialogue showing a progress-bar with some info /**
* Helper function to create a dialogue showing a progress-bar with some info
*
* \param p_this Parent vlc_object * \param p_this Parent vlc_object
* \param psz_title Title for the dialog (NULL implies main intf ) * \param psz_title Title for the dialog (NULL implies main intf )
* \param psz_status Current status * \param psz_status Current status
...@@ -281,7 +292,9 @@ int __intf_Progress( vlc_object_t *p_this, const char *psz_title, ...@@ -281,7 +292,9 @@ int __intf_Progress( vlc_object_t *p_this, const char *psz_title,
return p_new->i_id; return p_new->i_id;
} }
/** Update a progress bar in a dialogue /**
* Update a progress bar in a dialogue
*
* \param p_this Parent vlc_object * \param p_this Parent vlc_object
* \param i_id Identifier of the dialog * \param i_id Identifier of the dialog
* \param psz_status New status * \param psz_status New status
...@@ -318,8 +331,10 @@ void __intf_ProgressUpdate( vlc_object_t *p_this, int i_id, ...@@ -318,8 +331,10 @@ void __intf_ProgressUpdate( vlc_object_t *p_this, int i_id,
playlist_Signal( pl_Get( p_this ) ); playlist_Signal( pl_Get( p_this ) );
} }
/** Helper function to communicate dialogue cancellations between the /**
* Helper function to communicate dialogue cancellations between the
* interface module and the caller * interface module and the caller
*
* \param p_this Parent vlc_object * \param p_this Parent vlc_object
* \param i_id Identifier of the dialogue * \param i_id Identifier of the dialogue
* \return Either true or false * \return Either true or false
...@@ -345,7 +360,9 @@ vlc_bool_t __intf_UserProgressIsCancelled( vlc_object_t *p_this, int i_id ) ...@@ -345,7 +360,9 @@ vlc_bool_t __intf_UserProgressIsCancelled( vlc_object_t *p_this, int i_id )
return b_cancel; return b_cancel;
} }
/** Helper function to make a login/password dialogue /**
* Helper function to make a login/password dialogue
*
* \param p_this Parent vlc_object * \param p_this Parent vlc_object
* \param psz_title Title for the dialog * \param psz_title Title for the dialog
* \param psz_description A description * \param psz_description A description
...@@ -381,7 +398,9 @@ int __intf_UserLoginPassword( vlc_object_t *p_this, ...@@ -381,7 +398,9 @@ int __intf_UserLoginPassword( vlc_object_t *p_this,
return i_ret; return i_ret;
} }
/** Helper function to make a dialogue asking the user for !password string /**
* Helper function to make a dialogue asking the user for !password string
*
* \param p_this Parent vlc_object * \param p_this Parent vlc_object
* \param psz_title Title for the dialog * \param psz_title Title for the dialog
* \param psz_description A description * \param psz_description A description
...@@ -411,7 +430,9 @@ int __intf_UserStringInput( vlc_object_t *p_this, ...@@ -411,7 +430,9 @@ int __intf_UserStringInput( vlc_object_t *p_this,
return i_ret; return i_ret;
} }
/** Hide an interaction dialog /**
* Hide an interaction dialog
*
* \param p_this the parent vlc object * \param p_this the parent vlc object
* \param i_id the id of the item to hide * \param i_id the id of the item to hide
* \return nothing * \return nothing
...@@ -542,7 +563,7 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog ) ...@@ -542,7 +563,7 @@ static int DialogSend( vlc_object_t *p_this, interaction_dialog_t *p_dialog )
if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT ) return VLC_EGENERIC; if( p_this->i_flags & OBJECT_FLAGS_NOINTERACT ) return VLC_EGENERIC;
if( config_GetInt(p_this, "interact") || if( config_GetInt( p_this, "interact" ) ||
p_dialog->i_flags & DIALOG_BLOCKING_ERROR || p_dialog->i_flags & DIALOG_BLOCKING_ERROR ||
p_dialog->i_flags & DIALOG_NONBLOCKING_ERROR ) p_dialog->i_flags & DIALOG_NONBLOCKING_ERROR )
{ {
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment