wornvirtue
/
premiere-libtorrent
forked from premiere/premiere-libtorrent
1
0
Fork 0
Code Pull Requests Activity

fixed typos in docs

This commit is contained in:
Arvid Norberg 2010-08-27 16:35:00 +00:00
parent e2ca3e1545
commit 1133df4ac4
2 changed files with 23 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
docs/manual.html
View File

@ -62,7 +62,7 @@
<li><a class="reference internal" href="#set-max-connections-max-connections" id="id32">set_max_connections() max_connections()</a></li> <li><a class="reference internal" href="#set-max-connections-max-connections" id="id32">set_max_connections() max_connections()</a></li>
<li><a class="reference internal" href="#num-uploads-num-connections" id="id33">num_uploads() num_connections()</a></li> <li><a class="reference internal" href="#num-uploads-num-connections" id="id33">num_uploads() num_connections()</a></li>
<li><a class="reference internal" href="#set-max-half-open-connections-max-half-open-connections" id="id34">set_max_half_open_connections() max_half_open_connections()</a></li> <li><a class="reference internal" href="#set-max-half-open-connections-max-half-open-connections" id="id34">set_max_half_open_connections() max_half_open_connections()</a></li>
<li><a class="reference internal" href="#load-asnum-db-load-country-db-int-as-for-ip" id="id35">load_asnum_db() load_country_db() int as_for_ip()</a></li> <li><a class="reference internal" href="#load-asnum-db-load-country-db-as-for-ip" id="id35">load_asnum_db() load_country_db() as_for_ip()</a></li>
<li><a class="reference internal" href="#set-ip-filter" id="id36">set_ip_filter()</a></li> <li><a class="reference internal" href="#set-ip-filter" id="id36">set_ip_filter()</a></li>
<li><a class="reference internal" href="#get-ip-filter" id="id37">get_ip_filter()</a></li> <li><a class="reference internal" href="#get-ip-filter" id="id37">get_ip_filter()</a></li>
<li><a class="reference internal" href="#status" id="id38">status()</a></li> <li><a class="reference internal" href="#status" id="id38">status()</a></li>
@ -180,8 +180,8 @@
<li><a class="reference internal" href="#hasher" id="id138">hasher</a></li> <li><a class="reference internal" href="#hasher" id="id138">hasher</a></li>
<li><a class="reference internal" href="#fingerprint" id="id139">fingerprint</a></li> <li><a class="reference internal" href="#fingerprint" id="id139">fingerprint</a></li>
<li><a class="reference internal" href="#upnp-and-nat-pmp" id="id140">UPnP and NAT-PMP</a><ul> <li><a class="reference internal" href="#upnp-and-nat-pmp" id="id140">UPnP and NAT-PMP</a><ul>
<li><a class="reference internal" href="#add-mapping" id="id141">add_mapping</a></li> <li><a class="reference internal" href="#add-mapping" id="id141">add_mapping()</a></li>
<li><a class="reference internal" href="#delete-mapping" id="id142">delete_mapping</a></li> <li><a class="reference internal" href="#delete-mapping" id="id142">delete_mapping()</a></li>
<li><a class="reference internal" href="#router-model" id="id143">router_model()</a></li> <li><a class="reference internal" href="#router-model" id="id143">router_model()</a></li>
</ul> </ul>
</li> </li>
@ -896,8 +896,8 @@ their turn to get connected.</p>
<p><tt class="docutils literal"><span class="pre">max_half_open_connections()</span></tt> returns the set limit. This limit defaults <p><tt class="docutils literal"><span class="pre">max_half_open_connections()</span></tt> returns the set limit. This limit defaults
to 8 on windows.</p> to 8 on windows.</p>
</div> </div>
<div class="section" id="load-asnum-db-load-country-db-int-as-for-ip"> <div class="section" id="load-asnum-db-load-country-db-as-for-ip">
<h2>load_asnum_db() load_country_db() int as_for_ip()</h2> <h2>load_asnum_db() load_country_db() as_for_ip()</h2>
<blockquote> <blockquote>
<pre class="literal-block"> <pre class="literal-block">
void load_asnum_db(char const* file); void load_asnum_db(char const* file);
@ -931,10 +931,9 @@ generated.</p>
<div class="section" id="get-ip-filter"> <div class="section" id="get-ip-filter">
<h2>get_ip_filter()</h2> <h2>get_ip_filter()</h2>
<blockquote> <blockquote>
<dl class="docutils"> <pre class="literal-block">
<dt>::</dt> ip_filter get_ip_filter() const;
<dd>ip_filter get_ip_filter() const;</dd> </pre>
</dl>
</blockquote> </blockquote>
<p>Returns the ip_filter currently in the session. See <a class="reference internal" href="#ip-filter">ip_filter</a>.</p> <p>Returns the ip_filter currently in the session. See <a class="reference internal" href="#ip-filter">ip_filter</a>.</p>
</div> </div>
@ -4874,7 +4873,7 @@ public:
<p><tt class="docutils literal"><span class="pre">discover_device()</span></tt>, <tt class="docutils literal"><span class="pre">close()</span></tt> and <tt class="docutils literal"><span class="pre">rebind()</span></tt> are for internal uses and should <p><tt class="docutils literal"><span class="pre">discover_device()</span></tt>, <tt class="docutils literal"><span class="pre">close()</span></tt> and <tt class="docutils literal"><span class="pre">rebind()</span></tt> are for internal uses and should
not be called directly by clients.</p> not be called directly by clients.</p>
<div class="section" id="add-mapping"> <div class="section" id="add-mapping">
<h2>add_mapping</h2> <h2>add_mapping()</h2>
<blockquote> <blockquote>
<pre class="literal-block"> <pre class="literal-block">
int add_mapping(protocol_type p, int external_port, int local_port); int add_mapping(protocol_type p, int external_port, int local_port);
@ -4896,14 +4895,14 @@ is -1, which means failure. There will not be any error alert notification for
mappings that fail with a -1 return value.</p> mappings that fail with a -1 return value.</p>
</div> </div>
<div class="section" id="delete-mapping"> <div class="section" id="delete-mapping">
<h2>delete_mapping</h2> <h2>delete_mapping()</h2>
<blockquote> <blockquote>
<pre class="literal-block"> <pre class="literal-block">
void delete_mapping(int mapping_index); void delete_mapping(int mapping_index);
</pre> </pre>
</blockquote> </blockquote>
<p>This function removes a port mapping. <tt class="docutils literal"><span class="pre">mapping_index</span></tt> is the index that refers <p>This function removes a port mapping. <tt class="docutils literal"><span class="pre">mapping_index</span></tt> is the index that refers
to the mapping you want to remove, which was returned from <a class="reference internal" href="#add-mapping">add_mapping</a>.</p> to the mapping you want to remove, which was returned from <a class="reference internal" href="#add-mapping">add_mapping()</a>.</p>
</div> </div>
<div class="section" id="router-model"> <div class="section" id="router-model">
<h2>router_model()</h2> <h2>router_model()</h2>
@ -5254,7 +5253,7 @@ case it appears the client is not running on a NAT:ed network or if it
appears there is no NAT router that can be remote controlled to add port appears there is no NAT router that can be remote controlled to add port
mappings.</p> mappings.</p>
<p><tt class="docutils literal"><span class="pre">mapping</span></tt> refers to the mapping index of the port map that failed, i.e. <p><tt class="docutils literal"><span class="pre">mapping</span></tt> refers to the mapping index of the port map that failed, i.e.
the index returned from <a class="reference internal" href="#add-mapping">add_mapping</a>.</p> the index returned from <a class="reference internal" href="#add-mapping">add_mapping()</a>.</p>
<p><tt class="docutils literal"><span class="pre">map_type</span></tt> is 0 for NAT-PMP and 1 for UPnP.</p> <p><tt class="docutils literal"><span class="pre">map_type</span></tt> is 0 for NAT-PMP and 1 for UPnP.</p>
<p><tt class="docutils literal"><span class="pre">error</span></tt> tells you what failed.</p> <p><tt class="docutils literal"><span class="pre">error</span></tt> tells you what failed.</p>
<pre class="literal-block"> <pre class="literal-block">
@ -5274,7 +5273,7 @@ a port was successfully mapped on it. On a NAT:ed network with a NAT-PMP
capable router, this is typically generated once when mapping the TCP capable router, this is typically generated once when mapping the TCP
port and, if DHT is enabled, when the UDP port is mapped.</p> port and, if DHT is enabled, when the UDP port is mapped.</p>
<p><tt class="docutils literal"><span class="pre">mapping</span></tt> refers to the mapping index of the port map that failed, i.e. <p><tt class="docutils literal"><span class="pre">mapping</span></tt> refers to the mapping index of the port map that failed, i.e.
the index returned from <a class="reference internal" href="#add-mapping">add_mapping</a>.</p> the index returned from <a class="reference internal" href="#add-mapping">add_mapping()</a>.</p>
<p><tt class="docutils literal"><span class="pre">external_port</span></tt> is the external port allocated for the mapping.</p> <p><tt class="docutils literal"><span class="pre">external_port</span></tt> is the external port allocated for the mapping.</p>
<p><tt class="docutils literal"><span class="pre">type</span></tt> is 0 for NAT-PMP and 1 for UPnP.</p> <p><tt class="docutils literal"><span class="pre">type</span></tt> is 0 for NAT-PMP and 1 for UPnP.</p>
<pre class="literal-block"> <pre class="literal-block">

19
docs/manual.rst
View File

@ -651,8 +651,8 @@ their turn to get connected.
``max_half_open_connections()`` returns the set limit. This limit defaults ``max_half_open_connections()`` returns the set limit. This limit defaults
to 8 on windows. to 8 on windows.
load_asnum_db() load_country_db() int as_for_ip() load_asnum_db() load_country_db() as_for_ip()
------------------------------------------------- ---------------------------------------------
:: ::
@ -693,6 +693,7 @@ get_ip_filter()
--------------- ---------------
:: ::
ip_filter get_ip_filter() const; ip_filter get_ip_filter() const;
Returns the ip_filter currently in the session. See ip_filter_. Returns the ip_filter currently in the session. See ip_filter_.
@ -5017,8 +5018,8 @@ for the DHT port (UDP).
``discover_device()``, ``close()`` and ``rebind()`` are for internal uses and should ``discover_device()``, ``close()`` and ``rebind()`` are for internal uses and should
not be called directly by clients. not be called directly by clients.
add_mapping add_mapping()
----------- -------------
:: ::
@ -5042,15 +5043,15 @@ portmap_alert_ respectively. If The mapping fails immediately, the return value
is -1, which means failure. There will not be any error alert notification for is -1, which means failure. There will not be any error alert notification for
mappings that fail with a -1 return value. mappings that fail with a -1 return value.
delete_mapping delete_mapping()
-------------- ----------------
:: ::
void delete_mapping(int mapping_index); void delete_mapping(int mapping_index);
This function removes a port mapping. ``mapping_index`` is the index that refers This function removes a port mapping. ``mapping_index`` is the index that refers
to the mapping you want to remove, which was returned from add_mapping_. to the mapping you want to remove, which was returned from `add_mapping()`_.
router_model() router_model()
-------------- --------------
@ -5426,7 +5427,7 @@ appears there is no NAT router that can be remote controlled to add port
mappings. mappings.
``mapping`` refers to the mapping index of the port map that failed, i.e. ``mapping`` refers to the mapping index of the port map that failed, i.e.
the index returned from add_mapping_. the index returned from `add_mapping()`_.
``map_type`` is 0 for NAT-PMP and 1 for UPnP. ``map_type`` is 0 for NAT-PMP and 1 for UPnP.
@ -5450,7 +5451,7 @@ capable router, this is typically generated once when mapping the TCP
port and, if DHT is enabled, when the UDP port is mapped. port and, if DHT is enabled, when the UDP port is mapped.
``mapping`` refers to the mapping index of the port map that failed, i.e. ``mapping`` refers to the mapping index of the port map that failed, i.e.
the index returned from add_mapping_. the index returned from `add_mapping()`_.
``external_port`` is the external port allocated for the mapping. ``external_port`` is the external port allocated for the mapping.