summaryrefslogtreecommitdiff
path: root/shared-bindings
diff options
context:
space:
mode:
authorJames Bowman <jamesb@excamera.com>2020-02-03 18:41:32 -0800
committerJames Bowman <jamesb@excamera.com>2020-02-03 18:41:32 -0800
commit0bcfabbc87b3702e0bc37442ae68856c65ac9751 (patch)
tree30a11f4a17f8c61174c4b169d3bf700d3ed412d7 /shared-bindings
parent7fd30e7d2067bc0d94a57bd44519a59469a9f08b (diff)
Add header for module eveL explaining what it is.
Exclude modeveL-gen.h from Sphinx build
Diffstat (limited to 'shared-bindings')
-rw-r--r--shared-bindings/eveL/__init__.c12
1 files changed, 12 insertions, 0 deletions
diff --git a/shared-bindings/eveL/__init__.c b/shared-bindings/eveL/__init__.c
index 3bbffa257..7a549b856 100644
--- a/shared-bindings/eveL/__init__.c
+++ b/shared-bindings/eveL/__init__.c
@@ -33,6 +33,18 @@
// #if MICROPY_PY_BUILTINS_EVEL
+//| :mod:`eveL` --- low-level BridgeTek EVE bindings
+//| ================================================
+//|
+//| .. module:: eveL
+//| :synopsis: low-level BridgeTek EVE bindings
+//| :platform: SAMD21/SAMD51
+//|
+//| The `eveL` module provides a class EVEL which
+//| contains methods for constructing EVE command
+//| buffers and appending basic graphics commands.
+//|
+
typedef struct _mp_obj_EVEL_t {
mp_obj_base_t base;
mp_obj_t writer;