GDevelop

mirror of https://github.com/Heretek-AI/GDevelop.git synced 2026-08-27 03:01:28 -04:00

Files

T

Florian bb21d9a127 Updated doc.

git-svn-id: svn://localhost@1102 8062f311-0dae-4547-b526-b8ab9ac864a5

2013-07-01 20:40:24 +00:00

doxyfile

Updated doc.

2013-07-01 20:40:24 +00:00

Readme.txt

Updated doc.

2013-07-01 20:40:24 +00:00

yuidoc.json

Updated documentation.

2013-07-01 20:18:44 +00:00

Readme.txt

Organization

------------



"Platform documentation" contains the documentation of the C++ 

part of the platform ( which is used by the IDE ) : Open index.html.

"Runtime documentation" contains the documentation of the Javascript

game engine : Open index.html.



How to generate the documentation

---------------------------------



You need to have Doxygen ( www.doxygen.org ) 

and YUIdoc ( http://yui.github.io/yuidoc/ ).



To generate the platform documentation, just go in this folder

with a terminal, type "doxygen" and press Enter.



To generate the runtime documentation, go in this folder with

a terminal, type "yuidoc ." and press Enter.