2007-01-15 Eric Seidel <eric@webkit.org>
authoreseidel <eseidel@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Tue, 16 Jan 2007 00:46:38 +0000 (00:46 +0000)
committereseidel <eseidel@268f45cc-cd09-0410-ab3c-d52691b4dbfc>
Tue, 16 Jan 2007 00:46:38 +0000 (00:46 +0000)
        Reviewed by bdash.

        * coding/coding-style.html: update to include style for header guards

git-svn-id: https://svn.webkit.org/repository/webkit/trunk@18872 268f45cc-cd09-0410-ab3c-d52691b4dbfc

WebKitSite/ChangeLog
WebKitSite/coding/coding-style.html

index 28170a79f7fd74ed8c06655ff3d4049876686c11..65d53a86ab16404f2619e219cf7cd91e781c06ac 100644 (file)
@@ -1,3 +1,9 @@
+2007-01-15  Eric Seidel  <eric@webkit.org>
+
+        Reviewed by bdash.
+
+        * coding/coding-style.html: update to include style for header guards
+
 2007-01-10  Geoffrey Garen  <ggaren@apple.com>
 
         * coding/coding-style.html: Fixed minor validation error.
         * building/run.html: Added.
         * nav.inc:
 
-2006-10-05  Eric Seidel  <eric@eseidel.com>
+2006-10-05  Eric Seidel  <eric@webkit.org>
 
         Reviewed by Tim H.
 
         * coding/coding-style.html: use css styles, add example for whitespace, add example for c++ constructors
 
-2006-09-26  Eric Seidel  <eric@eseidel.com>
+2006-09-26  Eric Seidel  <eric@webkit.org>
 
         Reviewed by anders.
 
         * quality/lifecycle.html:
         * quality/reporting.html:
 
-2006-08-15  Eric Seidel  <eric@eseidel.com>
+2006-08-15  Eric Seidel  <eric@webkit.org>
 
         Reviewed by TimH.
 
index bc06a36eea81616b62dab247869a0f4c649f8cdd..8e90b12ac32cdbbb04e7bd6afb25f6f4cf0d1af5 100644 (file)
@@ -420,7 +420,7 @@ start with a lowercase letter and use intercaps.</li>
 <li> Macros that expand to function calls or other non-constant computation: these 
 should be named like functions, and should have parentheses at the end, even if 
 they take no arguments (with the exception of some special macros like ASSERT). 
-Note that usually it is preferrable to use an inline function in such cases instead of a macro.<br>
+Note that usually it is preferable to use an inline function in such cases instead of a macro.<br>
 
 <h4 class="right">Right:</h4>
 <pre class="code">
@@ -437,6 +437,21 @@ Note that usually it is preferrable to use an inline function in such cases inst
         NSLocalizedString(@"Stop", @"Stop button title")
 </pre>
 </li>
+<li>#define, #ifdef "header guards" should be named exactly the same as the file (including case), replacing the '.' with a '_'.
+<h4 class="right">Right:</h4>
+<pre class="code">
+// HTMLDocument.h
+#ifndef HTMLDocument_h
+#define HTMLDocument_h
+</pre>
+
+<h4 class="wrong">Wrong:</h4>
+<pre class="code">
+// HTMLDocument.h
+#ifndef _HTML_DOCUMENT_H_
+#define _HTML_DOCUMENT_H_
+</pre>
+</li>
 </ol>
 
 <h3>Other Punctuation</h3>