Difference between revisions of "Engine"
Jump to navigation
Jump to search
Rubenwardy (talk | contribs) m (Rubenwardy moved page Engine/Intro to Engine over redirect) |
Rubenwardy (talk | contribs) |
||
| Line 8: | Line 8: | ||
* [[Engine/Basic_data_structures|Basic data structures]] | * [[Engine/Basic_data_structures|Basic data structures]] | ||
* [http://doxy.minetest.net/ Doxygen] - For a complete (but often missing comments) reference to code. | * [http://doxy.minetest.net/ Doxygen] - For a complete (but often missing comments) reference to code. | ||
| + | |||
| + | == How to help improve documentation == | ||
| + | |||
| + | 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]. | ||
| + | |||
| + | Head over to #minetest-devon [[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. | ||
| + | |||
| + | [[Category:Core Engine]] | ||
Revision as of 19:35, 18 June 2020
Introduction
This page attempts to introduce a new contributor to the engine source code.
See also:
- Engine Structure - for a more detailed reference to components.
- Basic data structures
- Doxygen - For a complete (but often missing comments) reference to code.
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.
Head over to #minetest-devon 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.