premiere
/
premiere-libtorrent
2
2
Fork 1
Code Issues Pull Requests Releases Wiki Activity

documentation fixes

This commit is contained in:
Arvid Norberg 2013-12-19 06:51:03 +00:00
parent 4b81b3f90b
commit 2f43f2c428
3 changed files with 1803 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/gen_reference_doc.py
View File

@ -58,6 +58,8 @@ anon_index = 0
category_mapping = { category_mapping = {
'session.hpp': 'Session', 'session.hpp': 'Session',
'add_torrent_params.hpp': 'Session',
'session_status.hpp': 'Session',
'error_code.hpp': 'Error Codes', 'error_code.hpp': 'Error Codes',
'file.hpp': 'File', 'file.hpp': 'File',
'storage.hpp': 'Custom Storage', 'storage.hpp': 'Custom Storage',
@ -98,6 +100,7 @@ category_mapping = {
category_fun_mapping = { category_fun_mapping = {
'min_memory_usage()': 'Settings', 'min_memory_usage()': 'Settings',
'high_performance_seed()': 'Settings', 'high_performance_seed()': 'Settings',
'cache_status': 'Session',
} }
def categorize_symbol(name, filename): def categorize_symbol(name, filename):

1798
docs/reference-Session.html Normal file
View File

File diff suppressed because it is too large Load Diff

4
include/libtorrent/add_torrent_params.hpp
View File

@ -257,7 +257,7 @@ namespace libtorrent
// The optional parameter, ``resume_data`` can be given if up to date fast-resume data // The optional parameter, ``resume_data`` can be given if up to date fast-resume data
// is available. The fast-resume data can be acquired from a running torrent by calling // is available. The fast-resume data can be acquired from a running torrent by calling
// save_resume_data() on `torrent_handle`_. See fast-resume_. The ``vector`` that is // save_resume_data() on torrent_handle. See fast-resume_. The ``vector`` that is
// passed in will be swapped into the running torrent instance with ``std::vector::swap()``. // passed in will be swapped into the running torrent instance with ``std::vector::swap()``.
std::vector<char> resume_data; std::vector<char> resume_data;
@ -325,7 +325,7 @@ namespace libtorrent
// ``max_uploads``, ``max_connections``, ``upload_limit``, ``download_limit`` correspond // ``max_uploads``, ``max_connections``, ``upload_limit``, ``download_limit`` correspond
// to the ``set_max_uploads()``, ``set_max_connections()``, ``set_upload_limit()`` and // to the ``set_max_uploads()``, ``set_max_connections()``, ``set_upload_limit()`` and
// ``set_download_limit()`` functions on torrent_handle_. These values let you initialize // ``set_download_limit()`` functions on torrent_handle. These values let you initialize
// these settings when the torrent is added, instead of calling these functions immediately // these settings when the torrent is added, instead of calling these functions immediately
// following adding it. // following adding it.
// //