archive-gh-me/Espruino
1
0
Fork 0
mirror of https://github.com/espruino/Espruino.git synced 2025-12-08 19:06:15 +00:00
Code Issues Projects Releases Wiki Activity
Espruino/doxygen/README.md
Gordon Williams de6450e3d7 First pass at doxygen
2015-09-25 16:19:22 +01:00

469 B
Raw Permalink Blame History

Doxygen

Espruino's functions are tagged such that documentation can be built from them:

/// Comment before
void function();

/** Big comment before */
void function();

void function(); ///< Comment after

To build. go to the root of the Espruino project, install Doxygen, then run:@

doxygen Doxyfile

Most functions you care about will be in doxygen/html/globals_0x6a.html