Difference between revisions of "Engine documentation"

From Minetest Developer Wiki
Jump to navigation Jump to search
m (replace the explanation link, the old one did not work)
Line 6: Line 6:
  
 
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 [https://www.stack.nl/~dimitri/doxygen/manual/docblocks.html there].
+
The usage of doxygen is explained [http://www.doxygen.nl/manual/index.html there].
  
 
== Where to start ==
 
== Where to start ==

Revision as of 20:54, 31 July 2019

PLEASE NOTE: As of 2014, this page is grossly out of date. Ask on #minetest-dev.

Engine documentation is a way you can contribute to Minetest right now!

What we need

We want to document most or all of Minetest core with Doxygen-style code comments.
The usage of doxygen is explained there.

Where to start

Head over to #minetest-doc 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.