diff options
| author | Tatsuhiro Tsujikawa <tatsuhiro.t@gmail.com> | 2013-05-15 22:58:55 +0900 |
|---|---|---|
| committer | Tatsuhiro Tsujikawa <tatsuhiro.t@gmail.com> | 2013-05-15 22:58:55 +0900 |
| commit | a8ef703b894c2c0376c872fa35f3fc4f0a17ffe8 (patch) | |
| tree | 2c133cfe24d576995a7c12da614952b3e47acccd /src | |
| parent | a4a4a1049099dd563ce3a3cb87102a1e1da6206a (diff) | |
Update doc
Diffstat (limited to 'src')
| -rw-r--r-- | src/includes/aria2/aria2.h | 24 |
1 files changed, 13 insertions, 11 deletions
diff --git a/src/includes/aria2/aria2.h b/src/includes/aria2/aria2.h index 46281a66..a700784c 100644 --- a/src/includes/aria2/aria2.h +++ b/src/includes/aria2/aria2.h @@ -280,12 +280,13 @@ bool isNull(const A2Gid& gid); * and it should be BitTorrent Magnet URI. URIs in the |uris| must * point to the same file. If you mix other URIs which point to * another file, aria2 does not complain but download may fail. The - * |options| is an array of a pair of option name and value. If the - * |position| is not negative integer, the new download is inserted at - * position in the waiting queue. If the |position| is negative or the - * |position| is larger than the size of the queue, it is appended at - * the end of the queue. This function returns 0 if it succeeds, or - * negative error code. + * |options| is an array of a pair of option name and value. If + * unknown options are included in |options|, they are simply + * ignored. If the |position| is not negative integer, the new + * download is inserted at position in the waiting queue. If the + * |position| is negative or the |position| is larger than the size of + * the queue, it is appended at the end of the queue. This function + * returns 0 if it succeeds, or negative error code. */ int addUri(Session* session, A2Gid* gid, @@ -300,11 +301,12 @@ int addUri(Session* session, * the |metalinkFile|. On successful return, if the |gids| is not * ``NULL``, the GIDs of added downloads are appended to the * |*gids|. The |options| is an array of a pair of option name and - * value. If the |position| is not negative integer, the new download - * is inserted at position in the waiting queue. If the |position| is - * negative or the |position| is larger than the size of the queue, it - * is appended at the end of the queue. This function returns 0 if it - * succeeds, or negative error code. + * value. If unknown options are included in |options|, they are + * simply ignored. If the |position| is not negative integer, the new + * download is inserted at position in the waiting queue. If the + * |position| is negative or the |position| is larger than the size of + * the queue, it is appended at the end of the queue. This function + * returns 0 if it succeeds, or negative error code. */ int addMetalink(Session* session, std::vector<A2Gid>* gids, |