massive cleaning of file section headers

[physics.git] / src / codingstyle.txt

diff --git a/src/codingstyle.txt b/src/codingstyle.txt
index f1da776..b2fda27 100644 (file)
--- a/src/codingstyle.txt
+++ b/src/codingstyle.txt
@@ -18,20 +18,24 @@ This is in a very short form as it's mostly for myself.
 
 - sections of a file should be commented with the following where appropriate
   - they should appear in this order
-  - they should have two newlines before star lines, excluding the first
+  - they should have a newline above and below star lines
 
+Headers:
+/// ***** Header Class *****
+/// ***** Header Methods *****
+
+Source:
 /// ***** Private Method Headers *****
 /// ***** Private Variables *****
 
-/// ***** Constructors/Destructors *****
+/// ***** MAIN Method *****
 
-/// ***** Public Methods *****
-/// ***** Private Methods *****
+/// ***** Constructors/Destructors *****
+/// ***** Initializers/Cleaners *****
 
 /// ***** Public Class Methods *****
 /// ***** Protected Class Methods *****
 /// ***** Private Class Methods *****
 
-
-/// ***** Header Class *****
-/// ***** Header Methods *****
+/// ***** Public Methods *****
+/// ***** Private Methods *****