[Pidgin] CodingStandards modified

Pidgin trac at pidgin.im
Tue Aug 20 22:07:44 EDT 2013


Page "CodingStandards" was changed by MarkDoliner
Diff URL: <https://developer.pidgin.im/wiki/CodingStandards?action=diff&version=6>
Revision 6
Comment: Update text about comments
Changes:
-------8<------8<------8<------8<------8<------8<------8<------8<--------
Index: CodingStandards
=========================================================================
--- CodingStandards (version: 5)
+++ CodingStandards (version: 6)
@@ -40,12 +40,12 @@
 
 == 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. (If you find an undocumented or poorly documented function, please do submit a patch fixing it!)
+ * Function declarations in header files must be documented. See our other header files for examples. (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.
+// don't use this style--we don't like it
 
 /* Use this kind of comment for a single line... */
 
-------8<------8<------8<------8<------8<------8<------8<------8<--------

--
Page URL: <https://developer.pidgin.im/wiki/CodingStandards>
Pidgin <http://pidgin.im>
Pidgin

This is an automated message. Someone added your email address to be
notified of changes on 'CodingStandards' page.
If it was not you, please report to datallah at pidgin.im.


More information about the Wikiedit mailing list