Engine documentation

From Minetest Developer Wiki
Revision as of 16:28, 30 December 2014 by Celeron55 (talk | contribs)
Jump to navigation Jump to search

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 system for extracting information from those comments is not yet ready, but once we have comments in that format, it should be relatively simple to implement.

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.