Liav A
bef9ad4e44
Meta: Update all references of clang-format-14 to clang-format-15
...
Also, we add a section that describes how to get an updated clang-format
with multiple possible options to do that.
2022-12-04 09:13:24 -07:00
Arun Nanduri
e268316865
Documentation: Amend comment describing use of "virtual" and "final"
2022-09-06 19:15:54 +00:00
kleines Filmröllchen
008b46d06e
Documentation: Specify that no new code should contain C-style casts
...
Let's move towards a C-style-cast-free code base.
2022-05-29 20:36:16 +01:00
Andreas Kling
8f1ba8db4f
Documentation: Clarify text about virtual/override/final
2022-04-04 12:44:44 +02:00
Idan Horowitz
852ae6c195
Meta: Switch to clang-format-14 as the standard formatter
...
Now that clang-format-14 ubuntu packages are available, it's time to
finally upgrade our clang-format version. This version brings with it
a bunch of useful features with const-placement being the most notable.
These will be enabled in the following commits.
2022-04-01 21:24:45 +01:00
flyingwombat921
ed271aa7c5
Documentation: Swap 'Right' and 'Wrong' code practice
2022-01-16 15:16:44 -08:00
Ben Wiederhake
5e9cf47627
Documentation: Recommend a comment style
2021-11-05 21:07:35 +01:00
Ben Wiederhake
9df8c31cdc
Documentation: Fix broken empty links
...
The intention seems to be to enable links like:
https://github.com/SerenityOS/serenity/blob/master/Documentation/CodingStyle.md#east-const
However, this has never worked, and is also not how the syntax works.
Because there seems to be no demand for the intended feature (nobody
since 2019 fixed it), this patch removes it.
Found by markdown-checker.
2021-10-10 15:18:55 -07:00
kemzeb
b9980ffd07
Documentation: Remove redundancy in CodingStyle.md
...
This is a fairly small change; removed the statement "Pointer and
reference types in C++ code" as it does not provide any additional
knowledge that contributors are or will be aware of after further
reading into the "Pointers and References" section. It seems
unnecessary and redundant given the sentence adjacent to it.
2021-06-06 00:18:02 +01:00
Scott Antipa
7dab58ac3b
Documentation: Fix a typo by removing an extra word
2021-06-04 08:22:41 +01:00
Andreas Kling
dd9b8ee7ef
Documentation: Add rule about "east const" to CodingStyle.md
...
Unfortunately we cannot enforce this with clang-format yet, as that
feature is not available. Until then, let's try to write new code
with this in mind, and convert old code as we go.
2021-06-01 08:55:47 +02:00
Dexter
d697d33fa6
Documentation: Fix typo in CodingStyle.md ( #5121 )
2021-01-26 12:26:27 +01:00
Linus Groh
fb220d5678
Meta+Docs+CI: Require clang-format >= 11
2020-12-31 21:51:00 +01:00
Linus Groh
bcfc6f0c57
Everywhere: Fix more typos
2020-10-03 12:36:49 +02:00
DexesTTP
c715b13ffc
Meta: Updated CodingStyle.md clang-format requirement from 8 to 10
...
Fixes #2213
2020-05-15 09:48:14 +02:00
Andreas Kling
2b7fc08db3
Documentation: Add section about structs vs. classes to CodingStyle.md
2020-04-18 11:14:05 +02:00
Andreas Kling
af840af1ce
Documentation: Let's have a coding style document
...
This is only meant to be about higher-level coding style, not the small
things like brace placement, indentation, etc. For all of that we just
obey clang-format.
2019-08-21 17:01:29 +02:00
Robin Burchell
faafaf9b43
Documentation: RIP the short-lived coding style
...
Let's just use clang-format. It's easier than explaining the rules.
2019-05-28 17:31:20 +02:00
Andreas Kling
854598bc46
Documentation: Remove some irrelevant things from the coding style.
...
This was adapted from the WebKit coding style docs, but some parts of it
don't make sense for Serenity.
2019-05-28 11:43:28 +02:00
Andreas Kling
fc3732759d
Documentation: Import an attempt at describing the project coding style.
2019-05-28 11:40:44 +02:00
