Difference between revisions of "Engine documentation"

From Minetest Developer Wiki
Jump to navigation Jump to search
m
Line 5: Line 5:
 
== What we need ==
 
== What we need ==
  
We want to document most or all of Minetest core with [http://en.wikipedia.org/wiki/Doxygen 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.
+
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].
  
 
== Where to start ==
 
== Where to start ==

Revision as of 12:11, 20 April 2017

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.