A few documentation typos.

This commit is contained in:
Alden Torres 2015-12-11 08:45:08 -05:00
parent c1cb1393fb
commit e3fc859754
3 changed files with 10 additions and 10 deletions

View File

@ -303,7 +303,7 @@ namespace libtorrent
std::string name; std::string name;
// the path where the torrent is or will be stored. Note that this may // the path where the torrent is or will be stored. Note that this may
// alos be stored in resume data. If you want the save path saved in // also be stored in resume data. If you want the save path saved in
// the resume data to be used, you need to set the // the resume data to be used, you need to set the
// flag_use_resume_save_path flag. // flag_use_resume_save_path flag.
// //

View File

@ -195,7 +195,7 @@ namespace libtorrent
}; };
// The ``torrent_removed_alert`` is posted whenever a torrent is removed. Since // The ``torrent_removed_alert`` is posted whenever a torrent is removed. Since
// the torrent handle in its baseclass will always be invalid (since the torrent // the torrent handle in its base class will always be invalid (since the torrent
// is already removed) it has the info hash as a member, to identify it. // is already removed) it has the info hash as a member, to identify it.
// It's posted when the ``status_notification`` bit is set in the alert_mask. // It's posted when the ``status_notification`` bit is set in the alert_mask.
// //
@ -331,7 +331,7 @@ namespace libtorrent
// but it's limited by ``settings_pack::max_out_request_queue``. The queue length // but it's limited by ``settings_pack::max_out_request_queue``. The queue length
// libtorrent is trying to achieve is determined by the download rate and the // libtorrent is trying to achieve is determined by the download rate and the
// assumed round-trip-time (``settings_pack::request_queue_time``). The assumed // assumed round-trip-time (``settings_pack::request_queue_time``). The assumed
// rount-trip-time is not limited to just the network RTT, but also the remote disk // round-trip-time is not limited to just the network RTT, but also the remote disk
// access time and message handling time. It defaults to 3 seconds. The target number // access time and message handling time. It defaults to 3 seconds. The target number
// of outstanding requests is set to fill the bandwidth-delay product (assumed RTT // of outstanding requests is set to fill the bandwidth-delay product (assumed RTT
// times download rate divided by number of bytes per request). When this alert // times download rate divided by number of bytes per request). When this alert
@ -367,7 +367,7 @@ namespace libtorrent
// //
// min(512, max(upload_rate * send_buffer_watermark_factor / 100, send_buffer_watermark)) // min(512, max(upload_rate * send_buffer_watermark_factor / 100, send_buffer_watermark))
// //
// If you receive this alert, you migth want to either increase your ``send_buffer_watermark`` // If you receive this alert, you might want to either increase your ``send_buffer_watermark``
// or ``send_buffer_watermark_factor``. // or ``send_buffer_watermark_factor``.
send_buffer_watermark_too_low, send_buffer_watermark_too_low,
@ -511,7 +511,7 @@ namespace libtorrent
virtual std::string message() const TORRENT_OVERRIDE; virtual std::string message() const TORRENT_OVERRIDE;
// the data returned in the scrape response. These numbers // the data returned in the scrape response. These numbers
// may be -1 if the reponse was malformed. // may be -1 if the response was malformed.
int incomplete; int incomplete;
int complete; int complete;
}; };
@ -943,11 +943,11 @@ namespace libtorrent
error_code error; error_code error;
#ifndef TORRENT_NO_DEPRECATE #ifndef TORRENT_NO_DEPRECATE
// If the error happened for a speific file, ``file`` is its path. // If the error happened for a specific file, ``file`` is its path.
std::string file; std::string file;
#endif #endif
// If the error happened for a speific file, this returns its path. // If the error happened for a specific file, this returns its path.
char const* file_path() const; char const* file_path() const;
// If the error happened in a specific disk operation this is a NULL // If the error happened in a specific disk operation this is a NULL
@ -1786,10 +1786,10 @@ namespace libtorrent
}; };
// The incoming connection alert is posted every time we successfully accept // The incoming connection alert is posted every time we successfully accept
// an incoming connection, through any mean. The most straigh-forward ways // an incoming connection, through any mean. The most straight-forward ways
// of accepting incoming connections are through the TCP listen socket and // of accepting incoming connections are through the TCP listen socket and
// the UDP listen socket for uTP sockets. However, connections may also be // the UDP listen socket for uTP sockets. However, connections may also be
// accepted ofer a Socks5 or i2p listen socket, or via a torrent specific // accepted offer a Socks5 or i2p listen socket, or via a torrent specific
// listen socket for SSL torrents. // listen socket for SSL torrents.
struct TORRENT_EXPORT incoming_connection_alert TORRENT_FINAL : alert struct TORRENT_EXPORT incoming_connection_alert TORRENT_FINAL : alert
{ {

View File

@ -249,7 +249,7 @@ namespace libtorrent
// bytes though. This is useful when reading and writing the last piece // bytes though. This is useful when reading and writing the last piece
// of a file in unbuffered mode. // of a file in unbuffered mode.
// //
// The ``offset`` is aligned to 16 kiB boundries *most of the time*, but // The ``offset`` is aligned to 16 kiB boundaries *most of the time*, but
// there are rare exceptions when it's not. Specifically if the read // there are rare exceptions when it's not. Specifically if the read
// cache is disabled/or full and a peer requests unaligned data. Most // cache is disabled/or full and a peer requests unaligned data. Most
// clients request aligned data. // clients request aligned data.