Changes between Version 1 and Version 2 of StyleGuide

Timestamp:

May 21, 2008, 5:00:33 PM (16 years ago)

Author:

resiak

Comment:

Distill some style discussions from devel@cpi into the guidelines.

StyleGuide

@@ -1 +1 @@
 = Coding Standards =
 
-We try to follow K&R coding style in most of or code. Here are some examples to help explain:
+We try to follow K&R coding style in most of our code.  Some existing code violates these standards.  If you are writing a patch against some such code, please do fix violations in that block of code --- but don't reformat entire files!
+
+Here are some examples to help explain the intended style:
 
 == Braces ==
@@ -38 +40 @@
 == Comments ==
  * A comment or two in the static (non-exported) functions is good, but not essential.
- * Every function added in any header file must be documented. See any of the header files in our tree for example.
+ * Every function added in any header file must be documented. See any of the header files in our tree for example. (If you find an undocumented or poorly documented function, please do submit a patch fixing it!)
+ * Only use C89 comments, not C++/C99 one-line comments:
+
+{{{
+#!c
+// this kind of comment is not supported in C89, so cannot be used in our codebase.
+
+/* Use this kind of comment for a single line... */
+
+/* And if you have a comment spanning multiple lines,
+ * have a neat column of stars to the left!
+ */
+}}}
+
+== Function Definitions ==
+
+ * There should be a newline between the return type of the function and the function's name.
+ * One parameter per line.
+ * As mentioned above, the opening brace should be on a new line.
+
+For example:
+
+{{{
+#!c
+GtkWidget *
+do_some_magic_thing(int foo,
+                    gchar *bar)
+{
+        /* misc, other */
+}