From 5bb12793a0c978fc731e29d0dee00cdf86b8234f Mon Sep 17 00:00:00 2001 From: Nick Moore Date: Thu, 11 Oct 2018 22:19:46 +1100 Subject: update documentation and translations again --- shared-bindings/network/__init__.c | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) (limited to 'shared-bindings/network') 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)); -- cgit v1.2.3