summaryrefslogtreecommitdiffstatshomepage
path: root/py
diff options
context:
space:
mode:
authorDamien George <damien.p.george@gmail.com>2014-04-29 22:55:34 +0100
committerDamien George <damien.p.george@gmail.com>2014-04-29 22:55:34 +0100
commit8d09640b22714fa9c66a5a7bbf9ab59a6a0c710d (patch)
treef8f196bf58661af9668b14f69a20c15765aa459b /py
parent186e463a9ea5f1f1cabd928ba363fb3f0c0de4dc (diff)
downloadmicropython-8d09640b22714fa9c66a5a7bbf9ab59a6a0c710d.tar.gz
micropython-8d09640b22714fa9c66a5a7bbf9ab59a6a0c710d.zip
stmhal: Add documentation in comments, and script to generate HTML.
Decided to write own script to pull documentation from comments in C code. Style for writing auto generated documentation is: start line with /// and then use standard markdown to write the comment. Keywords recognised by the scraper begin with backslash. See code for examples. Running: python gendoc.py modpyb.c accel.c adc.c dac.c extint.c i2c.c led.c pin.c rng.c servo.c spi.c uart.c usrsw.c, will generate a HTML structure in gendoc-out/. gendoc.py is crude but functional. Needed something quick, and this was it.
Diffstat (limited to 'py')
0 files changed, 0 insertions, 0 deletions