summaryrefslogtreecommitdiff
path: root/shared-bindings/network
diff options
context:
space:
mode:
authorNick Moore <nick@zoic.org>2018-10-11 22:19:46 +1100
committerNick Moore <nick@zoic.org>2018-10-11 22:19:46 +1100
commit5bb12793a0c978fc731e29d0dee00cdf86b8234f (patch)
treeb2f2e6a26f291dbc016f1cd47ccce1a5278d71ad /shared-bindings/network
parenta4a0cf826b9d39f14317e6021ac2a5c08d575fbd (diff)
update documentation and translations again
Diffstat (limited to 'shared-bindings/network')
-rw-r--r--shared-bindings/network/__init__.c17
1 files changed, 11 insertions, 6 deletions
diff --git a/shared-bindings/network/__init__.c b/shared-bindings/network/__init__.c
index c5639b462..69f8bea60 100644
--- a/shared-bindings/network/__init__.c
+++ b/shared-bindings/network/__init__.c
@@ -36,18 +36,23 @@
#include "shared-bindings/network/__init__.h"
+#if MICROPY_PY_NETWORK
+
//| :mod:`network` --- Network Interface Management
//| ===============================================
//|
//| .. module:: network
//| :synopsis: Network Interface Management
//| :platform: SAMD
-
-#if MICROPY_PY_NETWORK
-
-/// \module network - network configuration
-///
-/// This module provides a registry of configured NICs.
+//|
+//| This module provides a registry of configured NICs.
+//| It is used by the 'socket' module to look up a suitable
+//| NIC when a socket is created.
+//|
+//| .. function:: route
+//|
+//| Returns a list of all configured NICs.
+//|
STATIC mp_obj_t network_route(void) {
return MP_OBJ_FROM_PTR(&MP_STATE_PORT(mod_network_nic_list));