Merge pull request #544 from aldenml/typos

Documentation typos
This commit is contained in:
Arvid Norberg 2016-03-14 21:04:47 -04:00
commit 48df15c753
7 changed files with 12 additions and 12 deletions

View File

@ -180,7 +180,7 @@ namespace libtorrent
} }
#endif #endif
// returns true if we can announec to this tracker now. // returns true if we can announce to this tracker now.
// The current time is passed in as ``now``. The ``is_seed`` // The current time is passed in as ``now``. The ``is_seed``
// argument is necessary because once we become a seed, we // argument is necessary because once we become a seed, we
// need to announce right away, even if the re-announce timer // need to announce right away, even if the re-announce timer

View File

@ -135,7 +135,7 @@ namespace libtorrent
enum { max_refcount = (1 << 30) - 1 }; enum { max_refcount = (1 << 30) - 1 };
// the number of references to this buffer. These references // the number of references to this buffer. These references
// might be in outstanding asyncronous requests or in peer // might be in outstanding asynchronous requests or in peer
// connection send buffers. We can't free the buffer until // connection send buffers. We can't free the buffer until
// all references are gone and refcount reaches 0. The buf // all references are gone and refcount reaches 0. The buf
// pointer in this struct doesn't count as a reference and // pointer in this struct doesn't count as a reference and

View File

@ -258,7 +258,7 @@ namespace libtorrent
// called once per second // called once per second
virtual void on_tick() {} virtual void on_tick() {}
// called when choosing peers to optimisticallly unchoke. peer's will be // called when choosing peers to optimistically unchoke. peer's will be
// unchoked in the order they appear in the given vector. if // unchoked in the order they appear in the given vector. if
// the plugin returns true then the ordering provided will be used and no // the plugin returns true then the ordering provided will be used and no
// other plugin will be allowed to change it. If your plugin expects this // other plugin will be allowed to change it. If your plugin expects this
@ -414,7 +414,7 @@ namespace libtorrent
virtual bool on_extension_handshake(bdecode_node const&) { return true; } virtual bool on_extension_handshake(bdecode_node const&) { return true; }
// returning true from any of the message handlers // returning true from any of the message handlers
// indicates that the plugin has handeled the message. // indicates that the plugin has handled the message.
// it will break the plugin chain traversing and not let // it will break the plugin chain traversing and not let
// anyone else handle the message, including the default // anyone else handle the message, including the default
// handler. // handler.
@ -470,7 +470,7 @@ namespace libtorrent
virtual void on_piece_pass(int /*index*/) {} virtual void on_piece_pass(int /*index*/) {}
virtual void on_piece_failed(int /*index*/) {} virtual void on_piece_failed(int /*index*/) {}
// called aproximately once every second // called approximately once every second
virtual void tick() {} virtual void tick() {}
// called each time a request message is to be sent. If true // called each time a request message is to be sent. If true
@ -491,7 +491,7 @@ namespace libtorrent
// are now ready to be sent to the lower layer. This must be at least // are now ready to be sent to the lower layer. This must be at least
// as large as the number of bytes passed in and may be larger if there // as large as the number of bytes passed in and may be larger if there
// is additional data to be inserted at the head of the send buffer. // is additional data to be inserted at the head of the send buffer.
// The additional data is retrived from the passed in vector. The // The additional data is retrieved from the passed in vector. The
// vector must be cleared if no additional data is to be inserted. // vector must be cleared if no additional data is to be inserted.
virtual int encrypt(std::vector<boost::asio::mutable_buffer>& /*send_vec*/) = 0; virtual int encrypt(std::vector<boost::asio::mutable_buffer>& /*send_vec*/) = 0;

View File

@ -511,7 +511,7 @@ namespace libtorrent
// a block or piece boundary. // a block or piece boundary.
flag_pad_file = 1, flag_pad_file = 1,
// this file is hiddent (sets the hidden attribute // this file is hidden (sets the hidden attribute
// on windows) // on windows)
flag_hidden = 2, flag_hidden = 2,
@ -534,7 +534,7 @@ namespace libtorrent
int file_index_at_offset(boost::int64_t offset) const; int file_index_at_offset(boost::int64_t offset) const;
// low-level function. returns a pointer to the internal storage for // low-level function. returns a pointer to the internal storage for
// the filename. This string may not be null terinated! // the filename. This string may not be null terminated!
// the ``file_name_len()`` function returns the length of the filename. // the ``file_name_len()`` function returns the length of the filename.
char const* file_name_ptr(int index) const; char const* file_name_ptr(int index) const;
int file_name_len(int index) const; int file_name_len(int index) const;

View File

@ -53,7 +53,7 @@ namespace libtorrent
namespace gzip_errors namespace gzip_errors
{ {
// libtorrent uses boost.system's ``error_code`` class to represent errors. libtorrent has // libtorrent uses boost.system's ``error_code`` class to represent errors. libtorrent has
// its own error category get_gzip_category() whith the error codes defined by error_code_enum. // its own error category get_gzip_category() with the error codes defined by error_code_enum.
enum error_code_enum enum error_code_enum
{ {
// Not an error // Not an error

View File

@ -334,7 +334,7 @@ namespace libtorrent
num_loaded_torrents, num_loaded_torrents,
num_pinned_torrents, num_pinned_torrents,
// these counter indices deliberatly // these counter indices deliberately
// match the order of socket type IDs // match the order of socket type IDs
// defined in socket_type.hpp. // defined in socket_type.hpp.
num_tcp_peers, num_tcp_peers,

View File

@ -394,7 +394,7 @@ namespace libtorrent
// store the given bencoded data as an immutable item in the DHT. // store the given bencoded data as an immutable item in the DHT.
// the returned hash is the key that is to be used to look the item // the returned hash is the key that is to be used to look the item
// up agan. It's just the sha-1 hash of the bencoded form of the // up again. It's just the sha-1 hash of the bencoded form of the
// structure. // structure.
sha1_hash dht_put_item(entry data); sha1_hash dht_put_item(entry data);