mirror of
https://github.com/espruino/Espruino.git
synced 2025-12-08 19:06:15 +00:00
24 lines
469 B
Markdown
24 lines
469 B
Markdown
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](https://www.stack.nl/~dimitri/doxygen), then run:@
|
|
|
|
```
|
|
doxygen Doxyfile
|
|
```
|
|
|
|
Most functions you care about will be in [doxygen/html/globals_0x6a.html](html/globals_0x6a.html)
|