Minor documentation fix
This commit is contained in:
parent
387498e54f
commit
6d16811bae
|
@ -240,7 +240,7 @@ namespace libtorrent
|
|||
// of the piece. ``piece`` is the piece index that was read. ``size`` is the
|
||||
// number of bytes that was read.
|
||||
//
|
||||
// If the operation fails, ec will indicat what went wrong.
|
||||
// If the operation fails, ec will indicate what went wrong.
|
||||
struct TORRENT_EXPORT read_piece_alert TORRENT_FINAL : torrent_alert
|
||||
{
|
||||
// internal
|
||||
|
@ -1469,11 +1469,11 @@ namespace libtorrent
|
|||
error_code error;
|
||||
|
||||
#ifndef TORRENT_NO_DEPRECATE
|
||||
// If the error happend to a specific file, ``file`` is the path to it.
|
||||
// If the error happened to a specific file, ``file`` is the path to it.
|
||||
std::string file;
|
||||
#endif
|
||||
|
||||
// If the error happend to a specific file, this returns the path to it.
|
||||
// If the error happened to a specific file, this returns the path to it.
|
||||
char const* file_path() const;
|
||||
|
||||
// If the error happened in a disk operation. a NULL-terminated string of
|
||||
|
@ -2226,7 +2226,7 @@ namespace libtorrent
|
|||
};
|
||||
|
||||
// holds statistics about a current dht_lookup operation.
|
||||
// a DHT lookup is the travesal of nodes, looking up a
|
||||
// a DHT lookup is the traversal of nodes, looking up a
|
||||
// set of target nodes in the DHT for retrieving and possibly
|
||||
// storing information in the DHT
|
||||
struct TORRENT_EXPORT dht_lookup
|
||||
|
|
|
@ -64,11 +64,11 @@ namespace libtorrent
|
|||
|
||||
// The disk buffer holder acts like a ``scoped_ptr`` that frees a disk buffer
|
||||
// when it's destructed, unless it's released. ``release`` returns the disk
|
||||
// buffer and transferres ownership and responsibility to free it to the caller.
|
||||
// buffer and transfers ownership and responsibility to free it to the caller.
|
||||
//
|
||||
// A disk buffer is freed by passing it to ``session_impl::free_disk_buffer()``.
|
||||
//
|
||||
// ``buffer()`` returns the pointer without transferring responsibility. If
|
||||
// ``get()`` returns the pointer without transferring responsibility. If
|
||||
// this buffer has been released, ``buffer()`` will return 0.
|
||||
struct TORRENT_EXPORT disk_buffer_holder
|
||||
{
|
||||
|
|
|
@ -588,7 +588,7 @@ namespace libtorrent
|
|||
// recorded as piece_downloading_reverse, which really means the same
|
||||
// as piece_downloading, it just saves space to also indicate that it
|
||||
// has a bit lower priority. The reverse bit is only relevant if the
|
||||
// state is piece_downloadin.
|
||||
// state is piece_downloading.
|
||||
boost::uint32_t download_state : 3;
|
||||
|
||||
// TODO: 2 having 8 priority levels is probably excessive. It should
|
||||
|
@ -660,7 +660,7 @@ namespace libtorrent
|
|||
// +---+---+---+
|
||||
// this '3' is called prio_factor
|
||||
//
|
||||
// the manually set priority takes presedence over the availability
|
||||
// the manually set priority takes precedence over the availability
|
||||
// by multiplying availability by priority.
|
||||
|
||||
int priority(piece_picker const* picker) const
|
||||
|
@ -774,7 +774,7 @@ namespace libtorrent
|
|||
mutable std::vector<int> m_priority_boundries;
|
||||
|
||||
// each piece that's currently being downloaded has an entry in this list
|
||||
// with block allocations. i.e. it says wich parts of the piece that is
|
||||
// with block allocations. i.e. it says which parts of the piece that is
|
||||
// being downloaded. This list is ordered by piece index to make lookups
|
||||
// efficient there are as many buckets as there are piece states. See
|
||||
// piece_pos::state_t. The only download state that does not have a
|
||||
|
|
Loading…
Reference in New Issue