Ignore:
Timestamp:
Oct 20, 2009, 4:43:51 AM (12 years ago)
Author:
charles
Message:

(trunk libT) change the new public API a little bit -- clearer, but a little wordier

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/libtransmission/torrent.h

    r9335 r9337  
    361361
    362362
    363 /* Like tr_torrentFindFile(), but splits the filename into base
    364  * (tr_torrent.incompleteDir or tr_torrent.downloadDir)  and subpath */
     363/**
     364 * @brief Like tr_torrentFindFile(), but splits the filename into base and subpath;
     365 *
     366 * If the file is found, "tr_buildPath( base, subpath, NULL )"
     367 * will generate the complete filename.
     368 *
     369 * @return true if the file is found, false otherwise.
     370 *
     371 * @param base if the torrent is found, this will be either
     372 *             tor->downloadDir or tor->incompleteDir
     373 * @param subpath on success, this pointer is assigned a newly-allocated
     374 *                string holding the second half of the filename.
     375 */
    365376tr_bool tr_torrentFindFile2( const tr_torrent *, tr_file_index_t fileNo,
    366377                             const char ** base, char ** subpath );
    367378
    368379
    369 /* Returns a newly-allocated string that's been munged to the form
    370  * that denotes to humans that it's a partial file.
    371  * This is like the filenames in tr_torrent.info.files --
    372  * it's not a complete filename by itself, but a fragment that
    373  * can be passed to tr_buildPath() */
     380/* Returns a newly-allocated version of the tr_file.name string
     381 * that's been modified to denote that it's not a complete file yet.
     382 * In the current implementation this is done by appending ".part"
     383 * a la Firefox. */
    374384char* tr_torrentBuildPartial( const tr_torrent *, tr_file_index_t fileNo );
    375385
    376386
    377 
    378 
    379387#endif
Note: See TracChangeset for help on using the changeset viewer.