Changeset ac05a695a7d8ae02fd879565df0bcddb23a90a4b

Show
Ignore:
Timestamp:
02/20/08 23:45:38 (7 months ago)
Author:
Rémi Duraffort <ivoire@videolan.org>
git-committer:
Rémi Duraffort <ivoire@videolan.org> 1203547538 +0000
git-parent:

[6fdb1920bc75b4f3a0b6b713732d2964cd2c1593]

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

Some comments to have a better doxygen documentation

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • src/playlist/item.c

    r99fab90 rac05a69  
    9090            p_item_in_category->p_input->i_type = ITEM_TYPE_PLAYLIST; 
    9191        } 
    92   
     92 
    9393        playlist_BothAddInput( p_playlist, p_child, p_item_in_category, 
    9494                PLAYLIST_APPEND | PLAYLIST_SPREPARSE , PLAYLIST_END, 
    …… 
    101101        } 
    102102    } 
    103   
     103 
    104104    PL_UNLOCK; 
    105105 
    …… 
    123123                      input_item_subitem_added, 
    124124                      p_item ); 
    125   
     125 
    126126} 
    127127 
    …… 
    172172 ***************************************************************************/ 
    173173 
    174 /** Delete a playlist item and detach its input item */ 
     174/** 
     175 * Delete item 
     176 * 
     177 * Delete a playlist item and detach its input item 
     178 * \param p_item item to delete 
     179 * \return VLC_SUCCESS 
     180*/ 
    175181int playlist_ItemDelete( playlist_item_t *p_item ) 
    176182{ 
    …… 
    182188} 
    183189 
    184 /** Remove an input item when it appears from a root playlist item */ 
     190/** 
     191 * Delete input item 
     192 * 
     193 * Remove an input item when it appears from a root playlist item 
     194 * \param p_playlist playlist object 
     195 * \param i_input_id id of the input to delete 
     196 * \param p_root root playlist item 
     197 * \param b_do_stop must stop or not the playlist 
     198 * \return VLC_SUCCESS or VLC_EGENERIC 
     199*/ 
    185200static int DeleteFromInput( playlist_t *p_playlist, int i_input_id, 
    186201                            playlist_item_t *p_root, vlc_bool_t b_do_stop ) 
    …… 
    205220} 
    206221 
    207 /** Remove an input item when it appears from a root playlist item */ 
     222/** 
     223 * Delete input item 
     224 * 
     225 * Remove an input item when it appears from a root playlist item 
     226 * \param p_playlist playlist object 
     227 * \param i_input_id id of the input to delete 
     228 * \param p_root root playlist item 
     229 * \param b_locked TRUE if the playlist is locked 
     230 * \return VLC_SUCCESS or VLC_EGENERIC 
     231 */ 
    208232int playlist_DeleteInputInParent( playlist_t *p_playlist, int i_input_id, 
    209233                                  playlist_item_t *p_root, vlc_bool_t b_locked ) 
    …… 
    217241} 
    218242 
    219 /** Remove an input item from ONELEVEL and CATEGORY */ 
     243/** 
     244 * Delete from input 
     245 * 
     246 * Remove an input item from ONELEVEL and CATEGORY 
     247 * \param p_playlist playlist object 
     248 * \param i_input_id id of the input to delete 
     249 * \param b_locked TRUE if the playlist is locked 
     250 * \return VLC_SUCCESS or VLC_ENOITEM 
     251 */ 
    220252int playlist_DeleteFromInput( playlist_t *p_playlist, int i_input_id, 
    221253                              vlc_bool_t b_locked ) 
    …… 
    232264} 
    233265 
     266/** 
     267 * Clear the playlist 
     268 * 
     269 * \param p_playlist playlist object 
     270 * \param b_locked TRUE if the playlist is locked 
     271 * \return nothing 
     272 */ 
    234273void playlist_Clear( playlist_t * p_playlist, vlc_bool_t b_locked ) 
    235274{ 
    …… 
    240279} 
    241280 
    242 /** Remove a playlist item from the playlist, given its id 
    243  * This function is to be used only by the playlist */ 
     281/** 
     282 * Delete playlist item 
     283 * 
     284 * Remove a playlist item from the playlist, given its id 
     285 * This function is to be used only by the playlist 
     286 * \param p_playlist playlist object 
     287 * \param i_id id of the item do delete 
     288 * \return VLC_SUCCESS or an error 
     289 */ 
    244290int playlist_DeleteFromItemId( playlist_t *p_playlist, int i_id ) 
    245291{ 
    …… 
    253299 * Playlist item addition 
    254300 ***************************************************************************/ 
    255 /** Add an item to the playlist or the media library 
     301/** 
     302 * Playlist add 
     303 * 
     304 * Add an item to the playlist or the media library 
    256305 * \param p_playlist the playlist to add into 
    257306 * \param psz_uri the mrl to add to the playlist 
    …… 
    262311 *        regardless of its size 
    263312 * \param b_playlist TRUE for playlist, FALSE for media library 
     313 * \param b_locked TRUE if the playlist is locked 
    264314 * \return The id of the playlist item 
    265315 */ 
    …… 
    286336 * \param i_options the number of options 
    287337 * \param b_playlist TRUE for playlist, FALSE for media library 
     338 * \param b_locked TRUE if the playlist is locked 
    288339 * \return The id of the playlist item 
    289340*/ 
    …… 
    307358} 
    308359 
    309 /** Add an input item to the playlist node */ 
     360/** 
     361 * Add an input item to the playlist node 
     362 * 
     363 * \param p_playlist the playlist to add into 
     364 * \param p_input the input item to add 
     365 * \param i_mode the mode used when adding 
     366 * \param i_pos the position in the playlist where to add. If this is 
     367 *        PLAYLIST_END the item will be added at the end of the playlist 
     368 *        regardless of its size 
     369 * \param b_playlist TRUE for playlist, FALSE for media library 
     370 * \param b_locked TRUE if the playlist is locked 
     371 * \return VLC_SUCCESS or VLC_ENOMEM 
     372*/ 
    310373int playlist_AddInput( playlist_t* p_playlist, input_item_t *p_input, 
    311374                       int i_mode, int i_pos, vlc_bool_t b_playlist, 
    …… 
    340403} 
    341404 
    342 /** Add an input item to p_direct_parent in the category tree, and to the 
    343  *  matching top category in onelevel **/ 
     405/** 
     406 * Add input 
     407 * 
     408 * Add an input item to p_direct_parent in the category tree, and to the 
     409 * matching top category in onelevel 
     410 * \param p_playlist the playlist to add into 
     411 * \param p_input the input item to add 
     412 * \param p_direct_parent the parent item to add into 
     413 * \param i_mode the mode used when adding 
     414 * \param i_pos the position in the playlist where to add. If this is 
     415 *        PLAYLIST_END the item will be added at the end of the playlist 
     416 *        regardless of its size 
     417 * \param i_cat id of the items category 
     418 * \param i_one id of the item onelevel category 
     419 * \param b_locked TRUE if the playlist is locked 
     420 * \return VLC_SUCCESS or VLC_ENOMEM 
     421 */ 
    344422int playlist_BothAddInput( playlist_t *p_playlist, 
    345423                           input_item_t *p_input, 
    …… 
    388466} 
    389467 
    390 /** Add an input item to a given node */ 
     468/** 
     469 * Add an input item to a given node 
     470 * 
     471 * \param p_playlist the playlist to add into 
     472 * \param p_input the input item to add 
     473 * \param p_parent the parent item to add into 
     474 * \param i_mode the mode used when addin 
     475 * \param i_pos the position in the playlist where to add. If this is 
     476 *        PLAYLIST_END the item will be added at the end of the playlist 
     477 *        regardless of its size 
     478 * \param b_locked TRUE if the playlist is locked 
     479 * \return the new playlist item 
     480 */ 
    391481playlist_item_t * playlist_NodeAddInput( playlist_t *p_playlist, 
    392482                                         input_item_t *p_input,