Difference between revisions of "Engine"
Jump to navigation
Jump to search
Rubenwardy (talk | contribs) |
Rubenwardy (talk | contribs) |
||
| Line 16: | Line 16: | ||
We want to document most or all of Minetest core with [http://en.wikipedia.org/wiki/Doxygen Doxygen-style] code comments.<br/> | We want to document most or all of Minetest core with [http://en.wikipedia.org/wiki/Doxygen Doxygen-style] code comments.<br/> | ||
The usage of doxygen is explained [http://www.doxygen.nl/manual/index.html there]. | The usage of doxygen is explained [http://www.doxygen.nl/manual/index.html there]. | ||
| + | |||
| + | Move stuff from [[Engine/NMPR|NMPR]] to [[Engine/Structure|Engine Structure]], and improve [[Engine/Structure|Engine Structure]] generally. | ||
Head over to #minetest-dev on [[IRC]], and ask someone there to help you get started with documentation. | Head over to #minetest-dev on [[IRC]], and ask someone there to help you get started with documentation. | ||
Revision as of 20:20, 18 June 2020
The engine section and core engine category is for documentation of the Minetest engine, which consists of a C++ core and a Lua builtin script.
This page contains links to useful information.
Useful Resources
- Engine Structure - for an introduction and light reference to the engine's structure. Start here.
- Basic data structures - general data structures.
- Objects - documentation on active and static objects.
- Doxygen - For a complete (but often missing comments) reference to code.
- See all pages on the engine.
- See Rules and Guidelines.
How to help improve documentation
We want to document most or all of Minetest core with Doxygen-style code comments.
The usage of doxygen is explained there.
Move stuff from NMPR to Engine Structure, and improve Engine Structure generally.
Head over to #minetest-dev on IRC, and ask someone there to help you get started with documentation. You'll need to download the project through Git and then make your changes.