Changeset 38824 in webkit

Timestamp:

Nov 27, 2008 5:43:51 PM (15 years ago)

Author:

jchaffraix@webkit.org

Message:

2008-11-27 Julien Chaffraix <​jchaffraix@webkit.org>

Reviewed by Eric Seidel.

Bug 22468: Coding style: config.h should only be included in implementation files, not in header
​https://bugs.webkit.org/show_bug.cgi?id=22468

Clarified the rules about config.h inclusion and added 2 new examples to illustrate it. Also
added an explanation about the implementation files.

• coding/coding-style.html:

Location:

trunk/WebKitSite

Files:

• ChangeLog (modified) (1 diff)
• coding/coding-style.html (modified) (3 diffs)

trunk/WebKitSite/ChangeLog

@@ +1 @@
+2008-11-27  Julien Chaffraix  <jchaffraix@webkit.org>
+
+        Reviewed by Eric Seidel.
+
+        Bug 22468: Coding style: config.h should only be included in implementation files, not in header
+        https://bugs.webkit.org/show_bug.cgi?id=22468
+
+        Clarified the rules about config.h inclusion and added 2 new examples to illustrate it. Also
+        added an explanation about the implementation files.
+
+        * coding/coding-style.html:
+
 2008-11-25  Dean Jackson  <dino@apple.com>
 

trunk/WebKitSite/coding/coding-style.html

@@ -70 +70 @@
 </li>
 
-<li>In an implementation file, code inside a namespace should <em>not</em> be indented.
+<li>In an implementation file (files with the extension .cpp, .c or .mm), code inside a namespace should <em>not</em> be indented.
 <h4 class="right">Right:</h4>
 <pre class="code">
@@ -599 +599 @@
 <ol>
 
-<li>All files must #include "config.h" first.
-
-<li>All files must #include the primary header second, just after "config.h".
-So for example, Node.cpp should include Node.h first, before other files.
-This guarantees that each header's completeness is tested, to make sure it
-can be compiled without requiring any other header files be included first.
+<li>All implementation files must #include "config.h" first. Header
+files should never include "config.h".
+
+<h4 class="right">Right:</h4>
+<pre class="code">
+// RenderLayer.h
+#include "Node.h"
+#include "RenderObject.h"
+#include "RenderView.h"
+</pre>
+
+<h4 class="wrong">Wrong:</h4>
+<pre class="code">
+// RenderLayer.h
+#include "config.h"
+
+#include "RenderObject.h"
+#include "RenderView.h"
+#include "Node.h"
+</pre>
+
+<li>All implementation files must #include the primary header second,
+just after "config.h". So for example, Node.cpp should include Node.h first,
+before other files. This guarantees that each header's completeness is tested.
+This also assures that each header can be compiled without requiring any other
+header files be included first.
 
 <li>Other #include statements should be in sorted order (case sensitive, as
@@ -610 +630 @@
 Don't bother to organize them in a logical order.
 
+<h4 class="right">Right:</h4>
+<pre class="code">
+// HTMLDivElement.cpp
+#include "config.h"
+#include "HTMLDivElement.h"
+
+#include "Attribute.h"
+#include "HTMLElement.h"
+#include "QualifiedName.h"
+
+</pre>
+
+<h4 class="wrong">Wrong:</h4>
+<pre class="code">
+// HTMLDivElement.cpp
+#include "HTMLElement.h"
+#include "HTMLDivElement.h"
+#include "QualifiedName.h"
+#include "Attribute.h"
+</pre>
+
 </ol>