Changeset 13809


Ignore:
Timestamp:
Jan 19, 2013, 8:50:57 AM (8 years ago)
Author:
jordan
Message:

(trunk) #1220 'change top folder names' -- tweak the API documentation in transmission.h

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/libtransmission/transmission.h

    r13807 r13809  
    11121112 * EXAMPLES
    11131113 *
    1114  *   Consider a torrent where
    1115  *   files[0].path is "frobnitz-linux/checksum" and
    1116  *   files[1].path is "frobnitz-linux/frobnitz.iso".
     1114 *   Consider a tr_torrent where its
     1115 *   info.files[0].name is "frobnitz-linux/checksum" and
     1116 *   info.files[1].name is "frobnitz-linux/frobnitz.iso".
    11171117 *
    11181118 *   1. tr_torrentRenamePath (tor, "frobnitz-linux", "foo") will rename
    1119  *      the "frotbnitz-linux" folder as "foo" and update files[*].path.
     1119 *      the "frotbnitz-linux" folder as "foo" and update files[*].name.
    11201120 *
    11211121 *   2. tr_torrentRenamePath (tor, "frobnitz-linux/checksum", "foo") will
    11221122 *      rename the "frobnitz-linux/checksum" file as "foo" and update
    1123  *      files[0].path to "frobnitz-linux/foo".
     1123 *      files[0].name to "frobnitz-linux/foo".
    11241124 *
    11251125 * RETURN
     
    11311131 *   On success, the callback's error argument will be 0.
    11321132 *
    1133  *   If oldpath can't be found in files[*].path, or if newname is already
    1134  *   in files[*].path, or contains a directory separator, or is NULL, "",
     1133 *   If oldpath can't be found in files[*].name, or if newname is already
     1134 *   in files[*].name, or contains a directory separator, or is NULL, "",
    11351135 *   ".", or "..", the error argument will be EINVAL.
    11361136 *
Note: See TracChangeset for help on using the changeset viewer.