# HG changeset patch
# User Matti Hamalainen <ccr@tnsp.org>
# Date 1210444042 -10800
# Node ID 8e8a82c9311a980758c930ef710b3a70a8922d02
# Parent  6fd552b6e5db41452ccb3108834a4ca28a3a823d
Add a note about Doxygen documentation.

diff -r 6fd552b6e5db -r 8e8a82c9311a HACKING
--- a/HACKING	Sat May 10 04:35:03 2008 +0300
+++ b/HACKING	Sat May 10 21:27:22 2008 +0300
@@ -22,6 +22,13 @@
 
 Coding guidelines
 =================
+- Public functions in Audacious core SHOULD be documented via Doxygen
+  comments! In this case "public" means any functions that span modules
+  OR are available to plugins.
+
+  Of course, most functions currently lack documentation. If you have
+  spare time, improve the situation.
+
 
 - We use Glib for portability. This means that we have sized integer types
   such as gint{16,32,64}, etc. and shorthand types like guint and guchar