[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]

[vidalia-svn] r3736: Update the HACKING document to recommend the new file naming (vidalia/trunk)



Author: edmanm
Date: 2009-04-28 16:28:36 -0400 (Tue, 28 Apr 2009)
New Revision: 3736

Modified:
   vidalia/trunk/HACKING
Log:

Update the HACKING document to recommend the new file naming convention.


Modified: vidalia/trunk/HACKING
===================================================================
--- vidalia/trunk/HACKING	2009-04-28 20:28:01 UTC (rev 3735)
+++ vidalia/trunk/HACKING	2009-04-28 20:28:36 UTC (rev 3736)
@@ -84,17 +84,17 @@
 
 2.1.1. Source File Names
   
-  C++ classes should be divided in to a <classname>.h file, containing the
-  class declarations, and a <classname>.cpp file containg the class
+  C++ classes should be divided in to a <ClassName>.h file, containing the
+  class declarations, and a <ClassName>.cpp file containg the class
   implementation. Each .cpp file should implement only one public class.
+  Filenames containing a class should follow the same "CamelCase"
+  capitalization format as the class name itself.
 
-  Source files that do not implement a C++ class should be named logically.
-  For example, threading code would go in thread.cpp and thread.h.
-  
-  Filenames should be all lower case to prevent potential cross-platform
-  compilation issues due to Windows being case insensitive as opposed to
-  nearly every OS being case sensitive.
+  Source files that do not implement a C++ class should be named logically and
+  in all lowercase letters. For example, threading-related code would go in
+  thread.cpp and thread.h. 
 
+
 2.1.2. Class Names
 
   Class names should begin with a capital letter. If a name is a combination
@@ -193,12 +193,14 @@
        ------------------------------------------------------------
        QCheckBox             chk            chkEnableFoo
        QComboBox             cmbo           cmboNames
+       QDialogButtonBox       -             buttonBox
        QFrame                frm            frmMain
        QGroupBox             grp            grpAdvanced
        QLabel                lbl            lblHeader
        QLineEdit             line           lineAddress
        QListView             lst            lstMessages
        QProgressBar          pbar           pbarDownload
+                              -             progressBar
        QPushButton           btn            btnClose
        QRadioButton          rdo            rdoSomeOption
        QSpinBox              spn            spnDial