summaryrefslogtreecommitdiff
path: root/shared-bindings
diff options
context:
space:
mode:
authorNick Moore <nick@zoic.org>2018-10-09 22:37:49 +1100
committerNick Moore <nick@zoic.org>2018-10-09 22:37:49 +1100
commit6d9c2c52540fd59f8d1addbd5088757844f3d01c (patch)
tree9b8709bd56191592d2aec07c48f991b6f2a5586a /shared-bindings
parenta60700b1c5a97047b26290745dae26025e3514cc (diff)
Documentation builds (though has no real content yet)
Diffstat (limited to 'shared-bindings')
-rw-r--r--shared-bindings/network/__init__.c7
-rw-r--r--shared-bindings/wiznet/__init__.c17
-rw-r--r--shared-bindings/wiznet/wiznet5k.c10
3 files changed, 33 insertions, 1 deletions
diff --git a/shared-bindings/network/__init__.c b/shared-bindings/network/__init__.c
index ad42fea5f..f28d5265c 100644
--- a/shared-bindings/network/__init__.c
+++ b/shared-bindings/network/__init__.c
@@ -36,6 +36,13 @@
#include "shared-bindings/network/__init__.h"
+//| :mod:`network` --- Network Interface Management
+//| ===============================================
+//|
+//| .. module:: network
+//| :synopsis: Network Interface Management
+//| :platform: SAMD
+
#if MICROPY_PY_NETWORK
/// \module network - network configuration
diff --git a/shared-bindings/wiznet/__init__.c b/shared-bindings/wiznet/__init__.c
index e448d2ef1..fbdac3885 100644
--- a/shared-bindings/wiznet/__init__.c
+++ b/shared-bindings/wiznet/__init__.c
@@ -35,6 +35,23 @@
#include "shared-bindings/network/__init__.h"
+//| :mod:`wiznet` --- Support for WizNet hardware
+//| =============================================
+//|
+//| .. module:: wiznet
+//| :synopsis: Support for WizNet hardware
+//| :platform: SAMD
+//|
+//| Doc content goes here
+//|
+//| Libraries
+//|
+//| .. toctree::
+//| :maxdepth: 3
+//|
+//| wiznet5k
+//|
+
extern const mod_network_nic_type_t mod_network_nic_type_wiznet5k;
STATIC const mp_rom_map_elem_t mp_module_wiznet_globals_table[] = {
diff --git a/shared-bindings/wiznet/wiznet5k.c b/shared-bindings/wiznet/wiznet5k.c
index b561806ae..ccbd2b115 100644
--- a/shared-bindings/wiznet/wiznet5k.c
+++ b/shared-bindings/wiznet/wiznet5k.c
@@ -50,7 +50,15 @@
#include "internet/dns/dns.h"
#include "internet/dhcp/dhcp.h"
-/// \moduleref network
+//| .. currentmodule:: wiznet
+//|
+//| :class:`WIZNET5K` -- wrapper for Wiznet 5500 Ethernet interface
+//| ===============================================================
+//|
+//| .. class:: WIZNET5K(spi, cs, rst)
+//|
+//| Create a new WIZNET5500 interface using the specified pins
+//|
typedef struct _wiznet5k_obj_t {
mp_obj_base_t base;