We need to improve the documentation on the API in the Wiki. A LOT. There's been much progress in the API and the documentation is really stale. Even the hooks are now incomplete, and they used to be the best of the best.
Therefore, I ask everyone capable to join in the "Documentation drive". Get your API.txt, pick a class and fix its documentation in the wiki completely. To give you an idea of what to write there, consult the documentation for cBlockArea or cFurnaceEntity, those two are the format what we're looking for:
http://www.mc-server.org/wiki/doku.php?i...cblockarea
http://www.mc-server.org/wiki/doku.php?i...naceentity
Even if you're not sure what individual class functions do, just list them in the Functions table, and put a FIXME into the notes, so that someone else may come and edit only that function's description.
The previous has been obsoleted by the APIDump plugin. To contribute to documentation, have a look at that plugin and consider adding documentation there. Read the rest of this topic for details.
Code samples for common usage would be most welcome, too.
It would be a good idea to drop a line into this thread before you go documenting a class, just in case someone else decided on the very same thing at the same time.
A big thank you to everyone doing this, in advance!
Therefore, I ask everyone capable to join in the "Documentation drive". Get your API.txt, pick a class and fix its documentation in the wiki completely. To give you an idea of what to write there, consult the documentation for cBlockArea or cFurnaceEntity, those two are the format what we're looking for:
http://www.mc-server.org/wiki/doku.php?i...cblockarea
http://www.mc-server.org/wiki/doku.php?i...naceentity
Even if you're not sure what individual class functions do, just list them in the Functions table, and put a FIXME into the notes, so that someone else may come and edit only that function's description.
The previous has been obsoleted by the APIDump plugin. To contribute to documentation, have a look at that plugin and consider adding documentation there. Read the rest of this topic for details.
Code samples for common usage would be most welcome, too.
It would be a good idea to drop a line into this thread before you go documenting a class, just in case someone else decided on the very same thing at the same time.
A big thank you to everyone doing this, in advance!