Skip to content

Commit

Permalink
Documentation: Remove some irrelevant things from the coding style.
Browse files Browse the repository at this point in the history
This was adapted from the WebKit coding style docs, but some parts of it
don't make sense for Serenity.
  • Loading branch information
awesomekling committed May 28, 2019
1 parent fc37327 commit 854598b
Showing 1 changed file with 1 addition and 30 deletions.
31 changes: 1 addition & 30 deletions Documentation/CodingStyle.md
Original file line number Diff line number Diff line change
Expand Up @@ -687,8 +687,6 @@ do_something(something, false);
set_resizable(NotResizable);
```

[](#names-objc-methods) Objective-C method names should follow the Cocoa naming guidelines — they should read like a phrase and each piece of the selector should start with a lowercase letter and use intercaps.

[](#names-enum-members) Enum members should use InterCaps with an initial capital letter.

[](#names-const-to-define) Prefer `const` to `#define`. Prefer inline functions to macros.
Expand Down Expand Up @@ -831,39 +829,12 @@ void MyClass::get_some_value(OutArgumentType* outArgument) const

### #include Statements

[](#include-config-h) All implementation files must `#include` `config.h` first. Header files should never include `config.h`.

###### Right:

```cpp
// RenderLayer.h
#include "Node.h"
#include "RenderObject.h"
#include "RenderView.h"
```

###### Wrong:

```cpp
// RenderLayer.h
#include "config.h"

#include "RenderObject.h"
#include "RenderView.h"
#include "Node.h"
```

[](#include-primary) 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.

[](#include-others) Other `#include` statements should be in sorted order (case sensitive, as done by the command-line sort tool or the Xcode sort selection command). Don't bother to organize them in a logical order.
[](#include-others) `#include` statements should be in sorted order (case sensitive, as done by the command-line sort tool or an IDE sort selection command). Don't bother to organize them in a logical order.

###### Right:

```cpp
// HTMLDivElement.cpp
#include "config.h"
#include "HTMLDivElement.h"

#include "Attribute.h"
#include "HTMLElement.h"
#include "QualifiedName.h"
Expand Down

0 comments on commit 854598b

Please sign in to comment.