mirror of
https://github.com/4ian/GDevelop.git
synced 2025-10-15 10:19:04 +00:00
157 lines
4.4 KiB
C
157 lines
4.4 KiB
C
/**
|
|
* \mainpage GDevelop Core
|
|
* \image html gdlogo.png
|
|
* \section welcome GDevelop Core documentation
|
|
*
|
|
* The **GDevelop Core** library contains the structure of a GDevelop game, classes and tools that are used by the *platforms* and the *GDevelop IDE*.
|
|
*
|
|
* \section gettingstarted Getting started
|
|
*
|
|
* In most cases, you should start by <a href="https://github.com/4ian/GDevelop/blob/master/newIDE/README.md">installing and launching the development version of GDevelop</a>.
|
|
*
|
|
* - If you're interested in writing extensions for GDevelop, read <a href="https://github.com/4ian/GDevelop/blob/master/newIDE/README-extensions.md">the documentation about extensions</a>.
|
|
* - If you want to dig more into how GDevelop is architectured and work on the core, read <a href="https://github.com/4ian/GDevelop/blob/master/Core/GDevelop-Architecture-Overview.md">GDevelop Architecture Overview</a>. Then, you can browse this reference to get more information about a class or function.
|
|
*
|
|
* \section other Other documentations
|
|
*
|
|
* GDevelop is architectured around a `Core` (this library), a game engine (`GDJS`) and extensions (`Extensions` folder). The editor (`newIDE` folder) is using all of these libraries.
|
|
*
|
|
* - [Open GDevelop JS Platform documentation](../GDJS Documentation/index.html)
|
|
* - <a href="https://github.com/4ian/GDevelop/blob/master/newIDE/README.md">Getting started with the editor</a>
|
|
* - <a href="https://github.com/4ian/GDevelop/blob/master/newIDE/README-extensions.md">Getting started with the extensions</a>
|
|
*/
|
|
|
|
/**
|
|
* \defgroup PlatformDefinition Platform Definition (Common classes used by all platforms)
|
|
*
|
|
* Classes defining the common concepts used by all platforms: gd::Project, gd::Layout...
|
|
*/
|
|
|
|
/**
|
|
* \defgroup IDE IDE Classes (Classes to be used to implement a development environment)
|
|
*
|
|
* Classes to be used to implement a development environment.
|
|
*/
|
|
|
|
/**
|
|
* \defgroup IDEDialogs IDE Dialogs (Pre-made dialogs to be used to implement a development environment)
|
|
*
|
|
* Pre-made dialogs to be used to implement a development environment
|
|
*/
|
|
|
|
/**
|
|
* \defgroup IDEDialogsEventsEditor Events Editor related classes
|
|
*
|
|
* Classes and tools used to implement an events editor.
|
|
* \ingroup IDEDialogs
|
|
*/
|
|
|
|
/**
|
|
* \defgroup Events Events (Classes defining the event system and some tools associated with events)
|
|
*
|
|
* Classes defining the event system and some tools associated with events
|
|
*/
|
|
|
|
/**
|
|
* \defgroup CommonProgrammingTools Common programming tools
|
|
*
|
|
* Common functions and tools for programming.
|
|
*/
|
|
|
|
/**
|
|
* \defgroup TinyXml Integrated TinyXml library
|
|
*
|
|
* See the full documentation of TinyXml [here](http://www.grinninglizard.com/tinyxmldocs/index.html).
|
|
*/
|
|
|
|
/**
|
|
* \defgroup SpriteObjectExtension Standard Sprite Object extension
|
|
* \ingroup BuiltinExtensions
|
|
*/
|
|
|
|
/**
|
|
* \class TiXmlAttribute
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlAttributeSet
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlBase
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlComment
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlCursor
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlDeclaration
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlDocument
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlElement
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlHandle
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlNode
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlOutStream
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlParsingData
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlPrinter
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlString
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlText
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlUnknown
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|
|
/**
|
|
* \class TiXmlVisitor
|
|
* \brief Part of the tinyxml library
|
|
* \ingroup TinyXml
|
|
*/
|