ManiaScript Documentation
Posted: 03 Jul 2012, 22:39
Edit Eole:
I made a tutorial on how to generate the ManiaScript API Documentation. It's available here:
http://maniaplanet.github.io/documentat ... e-doc.html
I explain how to generate the documentation from ManiaPlanet.exe, how to create an html version of the documentation with Doxygen and eventually give a batch file who do all of the above in one click.
(Click here to get the batch)
Edit2:
For more info about ManiaScript you can read this page:
http://maniaplanet.github.io/documentation/maniascript/
I'll try to update it over time.
===============================================================================================
Starting in the upcoming version, everyone will be able to generate ManiaScript API documentation. You have to launch ManiaPlanet.exe with the argument /generatescriptdoc=PATH_TO_SOME_FILE.
Exemple : ManiaPlanet.exe /generatescriptdoc=C:\Foobar.h
It will generate a file looking like C++, describing the script API. You can then use a tool such as Doxygen to generate a browsable documentation. There are still lots of blanks, but it will probably be useful anyway.
Here is an doc generated with the upcoming version :
http://files.maniaplanet.com/scriptdoc/2012-07-03.zip
And here is the little tool I use to generate the doc using Doxygen. Feel free to use it or adapt it to your needs.
(Launch the .bat file, it should open Maniaplanet. Close Maniaplanet, and you're set ^_^)
http://files.maniaplanet.com/scriptdoc/Doxygen.zip
I made a tutorial on how to generate the ManiaScript API Documentation. It's available here:
http://maniaplanet.github.io/documentat ... e-doc.html
I explain how to generate the documentation from ManiaPlanet.exe, how to create an html version of the documentation with Doxygen and eventually give a batch file who do all of the above in one click.
(Click here to get the batch)
Edit2:
For more info about ManiaScript you can read this page:
http://maniaplanet.github.io/documentation/maniascript/
I'll try to update it over time.
===============================================================================================
Starting in the upcoming version, everyone will be able to generate ManiaScript API documentation. You have to launch ManiaPlanet.exe with the argument /generatescriptdoc=PATH_TO_SOME_FILE.
Exemple : ManiaPlanet.exe /generatescriptdoc=C:\Foobar.h
It will generate a file looking like C++, describing the script API. You can then use a tool such as Doxygen to generate a browsable documentation. There are still lots of blanks, but it will probably be useful anyway.
Here is an doc generated with the upcoming version :
http://files.maniaplanet.com/scriptdoc/2012-07-03.zip
And here is the little tool I use to generate the doc using Doxygen. Feel free to use it or adapt it to your needs.
(Launch the .bat file, it should open Maniaplanet. Close Maniaplanet, and you're set ^_^)
http://files.maniaplanet.com/scriptdoc/Doxygen.zip