Heretek-AI/GDevelop

mirror of https://github.com/Heretek-AI/GDevelop.git synced 2026-07-23 02:25:52 -04:00

Files

T

Florian Rival df1fff36e4 Update GDJS documentation to add a index page and generate it from GenerateAllDocs script

2018-07-04 23:24:37 +01:00

849 B

Raw Blame History

GDJS Documentation

📚 Read the documentation online: GDJS Runtime (game engine) documentation or GDJS Platform documentation for the IDE.

How to generate the documentation

Install Doxygen and JSDoc.
To generate the GDJS Runtime (game engine) documentation:
```
cd GDJS
jsdoc -c docs/jsdoc.conf.json -t docs/jaguarjs-jsdoc docs/DocMainPage.md
```
Output will be in docs/GDJS Documentation in the GDevelop repository root.
To generate the GDJS Platform documentation for the IDE:
```
cd GDJS/docs
doxygen
```
Output will be in docs/GDJS Runtime Documentation in the GDevelop repository root.