RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-01-18 12:52:44 +01:00
Code Releases Activity

Merge pull request #5924 from miri64/sock/doc/fixes

Browse Source 
sock: doc fixes
This commit is contained in:
Alexandre Abadie 2016-10-12 10:15:57 +02:00 committed by GitHub
commit 7d05b9c22a
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
sys/include/net/sock/ip.h
View File

@ -59,8 +59,8 @@
* *
* Above you see a simple IPv6 server. Don't forget to also * Above you see a simple IPv6 server. Don't forget to also
* @ref including-modules "include" the IPv6 module of your networking * @ref including-modules "include" the IPv6 module of your networking
* implementation (e.g. `gnrc_ipv6_default` for @ref net_gnrc GNRC) and at least * implementation (e.g. `gnrc_ipv6_default` for @ref net_gnrc "GNRC") and at
* one network device. * least one network device.
* *
* After including header files for the @ref net_af "address families", * After including header files for the @ref net_af "address families",
* @ref net_protnum "protocol numbers" and the @ref net_sock_ip "raw `sock`s" * @ref net_protnum "protocol numbers" and the @ref net_sock_ip "raw `sock`s"
@ -194,7 +194,7 @@
* *
* Again: Don't forget to also @ref including-modules "include" the IPv6 module * Again: Don't forget to also @ref including-modules "include" the IPv6 module
* of your networking implementation (e.g. `gnrc_ipv6_default` for * of your networking implementation (e.g. `gnrc_ipv6_default` for
* @ref net_gnrc GNRC) and at least one network device. * @ref net_gnrc "GNRC") and at least one network device.
* *
* We first create again a `sock` with a local end point bound to any IPv6 * We first create again a `sock` with a local end point bound to any IPv6
* address. Note that we also could specify the remote end point here and not * address. Note that we also could specify the remote end point here and not

8
sys/include/net/sock/udp.h
View File

@ -60,11 +60,11 @@
* *
* Above you see a simple UDP echo server. Don't forget to also * Above you see a simple UDP echo server. Don't forget to also
* @ref including-modules "include" the IPv6 module of your networking * @ref including-modules "include" the IPv6 module of your networking
* implementation (e.g. gnrc_ipv6_default` for @ref net_gnrc GNRC) and at least * implementation (e.g. `gnrc_ipv6_default` for @ref net_gnrc GNRC) and at least
* one network device. * one network device.
* *
* After including header files for the @ref net_af "address families" and * After including header files for the @ref net_af "address families" and
* the @ref net_sock_ip "raw `sock`s" themselves, we create some buffer space * the @ref net_sock_udp "UDP `sock`s" themselves, we create some buffer space
* `buf` to store the data received by the server: * `buf` to store the data received by the server:
* *
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.c} * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ {.c}
@ -75,7 +75,7 @@
* ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* *
* To be able to listen for incoming packets we bind the `sock` by setting a * To be able to listen for incoming packets we bind the `sock` by setting a
* local end point with with a port (`12345` in this case). * local end point with a port (`12345` in this case).
* *
* We then proceed to create the `sock`. It is bound to `local` and thus listens * We then proceed to create the `sock`. It is bound to `local` and thus listens
* for UDP packets with @ref udp_hdr_t::dst_port "destination port" `12345`. * for UDP packets with @ref udp_hdr_t::dst_port "destination port" `12345`.
@ -194,7 +194,7 @@
* *
* Again: Don't forget to also @ref including-modules "include" the IPv6 module * Again: Don't forget to also @ref including-modules "include" the IPv6 module
* of your networking implementation (e.g. `gnrc_ipv6_default` for * of your networking implementation (e.g. `gnrc_ipv6_default` for
* @ref net_gnrc GNRC) and at least one network device. * @ref net_gnrc "GNRC") and at least one network device.
* *
* We first create again a `sock` with a local end point bound to any IPv6 * We first create again a `sock` with a local end point bound to any IPv6
* address and some port. Note that we also could specify the remote here and * address and some port. Note that we also could specify the remote here and