[OMPT-svn-commit] SF.net SVN: modplug:[868] trunk/OpenMPT/README

[<sag...@us...>]

Revision: 868
          http://modplug.svn.sourceforge.net/modplug/?rev=868&view=rev
Author:   saga-games
Date:     2011-05-08 20:31:56 +0000 (Sun, 08 May 2011)

Log Message:
-----------
README clarification

Modified Paths:
--------------
    trunk/OpenMPT/README

Modified: trunk/OpenMPT/README
===================================================================
--- trunk/OpenMPT/README	2011-05-08 20:24:49 UTC (rev 867)
+++ trunk/OpenMPT/README	2011-05-08 20:31:56 UTC (rev 868)
@@ -13,7 +13,8 @@
 
 Coding conventions (see below for an example):
 
-* Functions / methods are "underlined".
+* Functions / methods are "underlined" (The "//------" comment, see below for an
+  example what it should look like).
 * Place curly braces at the beginning of the line, not at the end
 * Generally make use of the custom index types like SAMPLEINDEX or ORDERINDEX
   when referring to samples, orders, etc.
@@ -21,6 +22,7 @@
 * CSoundFile::IsCompatibleMode() so that modules made with previous versions of
   MPT still sound correct (if the change is extremely small, this might be
   unnecessary)
+* CamelCase function and variable names are preferred.
 * When checking the module type, use something like
     if(GetType() & MOD_TYPE_XXX)
   instead of
@@ -31,7 +33,7 @@
 
 Code example:
 
-void foo::bar(int foobar)
+void Foo::Bar(int foobar)
 //-----------------------
 {
     while(true)


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.