Create project specific API Reference #6826
Unanswered
espruino-discuss
asked this question in
Porting to new Devices
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Posted at 2018-10-04 by JumJum
Espruino supports different boards and can be customized by defines like Net, Gtaphics, Neopixel etc.
May be, you have your own extensions. In that case it would be helpful to have an API documentation for your project.
In a first try I've added -BBoard parameter to build_docs.py, which changes argument to call common.get_jsondata, and adds a define in switch-path which handles -B parameters.
This would open the option to create board specific API documentation during make by calling$(FAMILY) $ (WRAPPERSOURCES)
python build_doc.py
And then add it to board zip file.
If this is of general interest I would open a pull request
Beta Was this translation helpful? Give feedback.
All reactions