Mercurial > audlegacy

comparison 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
comparison
equal deleted inserted replaced
4533:6fd552b6e5db 4534:8e8a82c9311a
20 when noticing and cleaning up uncompliant code.. or writing new code. 20 when noticing and cleaning up uncompliant code.. or writing new code.
21 21
22 22
23 Coding guidelines 23 Coding guidelines
24 ================= 24 =================
25 - Public functions in Audacious core SHOULD be documented via Doxygen
26 comments! In this case "public" means any functions that span modules
27 OR are available to plugins.
28
29 Of course, most functions currently lack documentation. If you have
30 spare time, improve the situation.
31
25 32
26 - We use Glib for portability. This means that we have sized integer types 33 - We use Glib for portability. This means that we have sized integer types
27 such as gint{16,32,64}, etc. and shorthand types like guint and guchar 34 such as gint{16,32,64}, etc. and shorthand types like guint and guchar
28 provided, so please do use them. 35 provided, so please do use them.
29 36