mirror of https://github.com/OpenTTD/OpenTTD.git
Codechange: Add main page to script API documentation
This commit is contained in:
parent
dfa2622153
commit
40e6230900
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file ai_changelog.hpp Lists all changes / additions to the API.
|
||||
* @page ai_changelog Lists all changes / additions to the API.
|
||||
*
|
||||
* Only new / renamed / deleted api functions will be listed here. A list of
|
||||
* bug fixes can be found in the normal changelog. Note that removed API
|
||||
|
@ -457,3 +457,17 @@
|
|||
* \b 0.7.0
|
||||
* \li First stable release with the NoAI framework.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @mainpage
|
||||
*
|
||||
* What's new?
|
||||
* \li \ref ai_changelog
|
||||
*
|
||||
* Main classes:
|
||||
* \li \ref AIInfo
|
||||
* \li \ref AIController
|
||||
*
|
||||
* Detail topics:
|
||||
* \li \ref script_ids
|
||||
*/
|
||||
|
|
|
@ -6,7 +6,7 @@
|
|||
*/
|
||||
|
||||
/**
|
||||
* @file game_changelog.hpp Lists all changes / additions to the API.
|
||||
* @page game_changelog Lists all changes / additions to the API.
|
||||
*
|
||||
* Only new / renamed / deleted api functions will be listed here. A list of
|
||||
* bug fixes can be found in the normal changelog. Note that removed API
|
||||
|
@ -301,3 +301,17 @@
|
|||
* \b 1.2.0
|
||||
* \li First stable release with the NoGo framework.
|
||||
*/
|
||||
|
||||
/**
|
||||
* @mainpage
|
||||
*
|
||||
* What's new?
|
||||
* \li \ref game_changelog
|
||||
*
|
||||
* Main classes:
|
||||
* \li \ref GSInfo
|
||||
* \li \ref GSController
|
||||
*
|
||||
* Detail topics:
|
||||
* \li \ref script_ids
|
||||
*/
|
||||
|
|
|
@ -7,7 +7,10 @@
|
|||
|
||||
/**
|
||||
* @file script_types.hpp Defines all the types of the game, like IDs of various objects.
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @page script_ids Identifying game object
|
||||
* IDs are used to identify certain objects. They are only unique within the object type, so for example a vehicle may have VehicleID 2009,
|
||||
* while a station has StationID 2009 at the same time. Also IDs are assigned arbitrary, you cannot assume them to be consecutive.
|
||||
* Also note that some IDs are static and never change, while others are allocated dynamically and might be
|
||||
|
|
Loading…
Reference in New Issue