From fb2bcb57bb085d3519d4b6b96d23e1bc04f7ffc7 Mon Sep 17 00:00:00 2001 From: thalieht Date: Mon, 7 May 2018 20:31:18 +0300 Subject: [PATCH] Clarify guidelines and fix some typos --- CODING_GUIDELINES.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/CODING_GUIDELINES.md b/CODING_GUIDELINES.md index 5e0f47a1e..0ed8fd428 100644 --- a/CODING_GUIDELINES.md +++ b/CODING_GUIDELINES.md @@ -239,11 +239,11 @@ The headers should be placed in the following group order: 4. Boost library headers 5. Libtorrent headers 6. Qt headers - 7. qBittorrent own headers, starting from *base* headers. + 7. qBittorrent's own headers, starting from the *base* headers. The headers should be ordered alphabetically within each group. If there are conditionals for the same header group, then put them at the bottom of the respective group. -If there are conditionals for the different header groups, then put them above of the "qBittorrent own headers" group. +If there are conditionals that contain headers from several different header groups, then put them above the "qBittorrent's own headers" group. One exception is the header containing the library version (for example, QtGlobal), this particular header isn't constrained by the aforementioned order. @@ -285,13 +285,13 @@ Example: #include #endif -// conditional for the different header groups +// conditional that contains headers from several different header groups #if LIBTORRENT_VERSION_NUM >= 10100 #include #include #endif -// qBittorrent own headers +// qBittorrent's own headers #include "base/bittorrent/infohash.h" #include "anothermodule.h" #include "ui_examplewidget.h"