Is there any way to create a board specific API documentation ?
Implementation on different boards sometimes add specific commands.
And don't support some core functions.
At least for some boards we could add a file similar to http://www.espruino.com/Reference to download
You'd have to look at build_docs.py and common.py - I think you've delved around in that sort of stuff before.
So it looks like right now it doesn't do it, but get_jsondata checks is_for_document and only discards documentation based on what's defined if is_for_document=false.
I guess a 'docs' target could be added to the Makefile, then you could add all the -DABCD=1 style defines that usually get added to build_jswrapper to the command-line, could have a way of disabling the is_for_document=false check and you'd be sorted
Of course I guess it'd be of more use to everyone if the existing reference page could be revamped so it was more readable. There's just too much stuff there at the moment.
Potentially we could add info to the BOARD.json files on which functions were available, and then we could actually have the option to filter based on board.
Don't worry about formatting, just type in the text and we'll take care of making sense of it. We will auto-convert links, and if you put asterisks around words we will make them bold.
For a full reference visit the Markdown syntax.
© Espruino, powered by microcosm.
Report a problem