svn commit - mysqldoc@docsrva: r2530 - trunk/internals

[istruewing]

Author: istruewing
Date: 2006-06-27 16:14:52 +0200 (Tue, 27 Jun 2006)
New Revision: 2530

Log:
Clarified the use of empty lines.


Modified:
   trunk/internals/internals.xml

Modified: trunk/internals/internals.xml
===================================================================
--- trunk/internals/internals.xml	2006-06-27 14:14:29 UTC (rev 2529)
+++ trunk/internals/internals.xml	2006-06-27 14:14:52 UTC (rev 2530)
@@ -2309,21 +2309,31 @@
 
         <listitem>
           <para>
-            To separate two functions, use two line breaks. To separate
-            a list of variable declarations from executable statements,
-            use two line breaks. To separate a function from a block of
-            code, use two line breaks. For example:
+            You may use empty lines (two line breaks in a row) wherever
+            it seems helpful for readability. But never use two or more
+            empty lines in a row. The only exception is after a function
+            definition (see below).
           </para>
+        </listitem>
 
+        <listitem>
+          <para>
+            To separate two functions, use three line breaks (two empty
+            lines). To separate a list of variable declarations from
+            executable statements, use two line breaks (one empty line).
+            For example:
+          </para>
+
 <programlisting>
 int function_1()
 {
   int i;
   int j;
-  
+
   function0();
 }
 
+
 int function2()
 {
   return;
@@ -2791,8 +2801,8 @@
 
         <listitem>
           <para>
-            Put a line break between a function comment and its
-            description.
+            Put two line breaks (one empty line) between a function
+            comment and its description.
           </para>
 
 <programlisting>