Difference between revisions of "Engine"

From Minetest Developer Wiki
Jump to navigation Jump to search
Line 14: Line 14:
 
== How to help improve documentation ==
 
== How to help improve documentation ==
  
* Doxygen: We want to document most or all of Minetest core with [http://en.wikipedia.org/wiki/Doxygen Doxygen-style] code comments. The usage of doxygen is explained [http://www.doxygen.nl/manual/index.html there].<br>
+
* Doxygen: We want to document most or all of Minetest core with [http://en.wikipedia.org/wiki/Doxygen Doxygen-style] code comments.
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.
+
:* The usage of doxygen is explained [http://www.doxygen.nl/manual/index.html there].
 +
:* 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.
 
* Move stuff from [[Engine/NMPR|NMPR]] to [[Engine/Structure|Engine Structure]], and improve [[Engine/Structure|Engine Structure]] generally.
 
* Move stuff from [[Engine/NMPR|NMPR]] to [[Engine/Structure|Engine Structure]], and improve [[Engine/Structure|Engine Structure]] generally.
  
  
 
[[Category:Core Engine]]
 
[[Category:Core Engine]]

Revision as of 20:21, 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

How to help improve documentation

  • Doxygen: 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-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.