stmhal: Fix bugs in documentation so it compiles.

Othella · Sep 17, 2014 · 2842945 · 2842945
1 parent 8bb44f6
commit 2842945
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 2 deletions.
diff --git a/stmhal/irq.c b/stmhal/irq.c
@@ -33,6 +33,8 @@
 
 #include MICROPY_HAL_H
 
+/// \moduleref pyb
+
 /// \function wfi()
 /// Wait for an interrupt.
 /// This executies a `wfi` instruction which reduces power consumption

diff --git a/stmhal/modselect.c b/stmhal/modselect.c
@@ -174,7 +174,7 @@ STATIC mp_obj_t select_select(uint n_args, const mp_obj_t *args) {
 }
 MP_DEFINE_CONST_FUN_OBJ_VAR_BETWEEN(mp_select_select_obj, 3, 4, select_select);
 
-/// \class Poll
+/// \class Poll - poll class
 
 typedef struct _mp_obj_poll_t {
     mp_obj_base_t base;

diff --git a/stmhal/modwiznet5k.c b/stmhal/modwiznet5k.c
@@ -168,6 +168,8 @@ STATIC mp_obj_t format_net_addr(uint8_t *ip, mp_uint_t port) {
 /******************************************************************************/
 // Micro Python bindings
 
+/// \class WIZnet5k - driver for WIZnet5x00 Ethernet modules
+
 STATIC void wiznet5k_print(void (*print)(void *env, const char *fmt, ...), void *env, mp_obj_t self_in, mp_print_kind_t kind) {
     print(env, "WIZnet5k()");
 }

diff --git a/tools/gendoc.py b/tools/gendoc.py
@@ -347,7 +347,7 @@ def write(self, dir):
 regex_descr = r'(?P<descr>.*)'
 
 doc_regexs = (
-    (Doc.process_module, re.compile(r'\\module (?P<id>[a-z]+) - ' + regex_descr + r'$')),
+    (Doc.process_module, re.compile(r'\\module (?P<id>[a-z][a-z0-9]*) - ' + regex_descr + r'$')),
     (Doc.process_moduleref, re.compile(r'\\moduleref (?P<id>[a-z]+)$')),
     (Doc.process_function, re.compile(r'\\function (?P<id>[a-z0-9_]+)(?P<args>\(.*\))$')),
     (Doc.process_classmethod, re.compile(r'\\classmethod (?P<id>\\?[a-z0-9_]+)(?P<args>\(.*\))$')),