fix documentation bugs

This commit is contained in:
arvidn 2015-11-20 01:00:39 -05:00
parent daee339ac2
commit f03cefceb6
3 changed files with 10 additions and 9 deletions

View File

@ -273,14 +273,13 @@ namespace libtorrent
flag_stop_when_ready = 0x4000, flag_stop_when_ready = 0x4000,
// internal // internal
default_flags = flag_pinned | flag_update_subscribe default_flags = flag_pinned | flag_update_subscribe | flag_auto_managed | flag_paused | flag_apply_ip_filter
| flag_auto_managed | flag_paused | flag_apply_ip_filter
#ifndef TORRENT_NO_DEPRECATE #ifndef TORRENT_NO_DEPRECATE
, flag_ignore_flags = 0x80000000 , flag_ignore_flags = 0x80000000
#endif #endif
}; };
// filled in by the constructor and should be left untouched. It is used // filled in by the constructor and should be left untouched. It is used
// for forward binary compatibility. // for forward binary compatibility.
int version; int version;

View File

@ -558,7 +558,7 @@ namespace libtorrent
// torrent will *force stop* whenever it transitions from a // torrent will *force stop* whenever it transitions from a
// non-data-transferring state into a data-transferring state (referred to // non-data-transferring state into a data-transferring state (referred to
// as being ready to download or seed). This is useful for torrents that // as being ready to download or seed). This is useful for torrents that
// should not start downloading or seeding yet, but what to be made ready // should not start downloading or seeding yet, but want to be made ready
// to do so. A torrent may need to have its files checked for instance, so // to do so. A torrent may need to have its files checked for instance, so
// it needs to be started and possibly queued for checking (auto-managed // it needs to be started and possibly queued for checking (auto-managed
// and started) but as soon as it's done, it should be stopped. // and started) but as soon as it's done, it should be stopped.
@ -725,11 +725,11 @@ namespace libtorrent
// // if we don't get an alert within 10 seconds, abort // // if we don't get an alert within 10 seconds, abort
// if (a == 0) break; // if (a == 0) break;
// //
// std::vector<alert*> alerts; // std::vector<alert*> alerts;
// ses.pop_alerts(&alerts); // ses.pop_alerts(&alerts);
// //
// for (alert* i : alerts) // for (alert* i : alerts)
// { // {
// if (alert_cast<save_resume_data_failed_alert>(a)) // if (alert_cast<save_resume_data_failed_alert>(a))
// { // {
// process_alert(a); // process_alert(a);
@ -746,14 +746,14 @@ namespace libtorrent
// //
// torrent_handle h = rd->handle; // torrent_handle h = rd->handle;
// torrent_status st = h.status(torrent_handle::query_save_path // torrent_status st = h.status(torrent_handle::query_save_path
// | torrent_handle::query_name); // | torrent_handle::query_name);
// std::ofstream out((st.save_path // std::ofstream out((st.save_path
// + "/" + st.name + ".fastresume").c_str() // + "/" + st.name + ".fastresume").c_str()
// , std::ios_base::binary); // , std::ios_base::binary);
// out.unsetf(std::ios_base::skipws); // out.unsetf(std::ios_base::skipws);
// bencode(std::ostream_iterator<char>(out), *rd->resume_data); // bencode(std::ostream_iterator<char>(out), *rd->resume_data);
// --outstanding_resume_data; // --outstanding_resume_data;
// } // }
// } // }
// //
//.. note:: //.. note::

View File

@ -79,6 +79,7 @@ namespace libtorrent
// This torrent will wait for its turn. // This torrent will wait for its turn.
queued_for_checking, queued_for_checking,
#else #else
// internal
unused_enum_for_backwards_compatibility, unused_enum_for_backwards_compatibility,
#endif #endif
@ -125,6 +126,7 @@ namespace libtorrent
#ifndef TORRENT_NO_DEPRECATE #ifndef TORRENT_NO_DEPRECATE
std::string error; std::string error;
#else #else
// internal
std::string _dummy_string_; std::string _dummy_string_;
#endif #endif
error_code errc; error_code errc;