classref: Sync with current source

Also fix hyperlink references to same class as per the guidelines.
[ci skip]
This commit is contained in:
Rémi Verschelde
2017-10-22 12:56:11 +02:00
parent 14b1741cbf
commit fc09e14366
75 changed files with 240 additions and 225 deletions

View File

@ -15,7 +15,7 @@
<return type="void">
</return>
<description>
Close the UDP socket the [PacketPeerUDP] is currently listening on.
Close the UDP socket the [code]PacketPeerUDP[/code] is currently listening on.
</description>
</method>
<method name="get_packet_ip" qualifiers="const">
@ -36,7 +36,7 @@
<return type="bool">
</return>
<description>
Return whether this [PacketPeerUDP] is listening.
Return whether this [code]PacketPeerUDP[/code] is listening.
</description>
</method>
<method name="listen">
@ -49,7 +49,7 @@
<argument index="2" name="recv_buf_size" type="int" default="65536">
</argument>
<description>
Make this [PacketPeerUDP] listen on the "port" binding to "bind_address" with a buffer size "recv_buf_size".
Make this [code]PacketPeerUDP[/code] listen on the "port" binding to "bind_address" with a buffer size "recv_buf_size".
If "bind_address" is set as "*" (default), the peer will listen on all available addresses (both IPv4 and IPv6).
If "bind_address" is set as "0.0.0.0" (for IPv4) or "::" (for IPv6), the peer will listen on all available addresses matching that IP type.
If "bind_address" is set to any valid address (e.g. "192.168.1.101", "::1", etc), the peer will only listen on the interface with that addresses (or fail if no interface with the given address exists).