Mercurial > audlegacy

diff HACKING @ 4534:8e8a82c9311a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Add a note about Doxygen documentation.
author Matti Hamalainen <ccr@tnsp.org>
date Sat, 10 May 2008 21:27:22 +0300
parents fa676e489b64
children 785b606fd504
line wrap: on
line diff
--- 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