d4708/qBittorrent
1
0
Fork 0
mirror of https://github.com/d47081/qBittorrent.git synced 2025-01-22 20:44:15 +00:00
Code Issues Projects Releases Wiki Activity

Clarify guidelines and fix some typos

Browse Source
This commit is contained in:
thalieht 2018-05-07 20:31:18 +03:00
parent 20ca90800d
commit fb2bcb57bb
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CODING_GUIDELINES.md
View File

@ -239,11 +239,11 @@ The headers should be placed in the following group order:
4. Boost library headers 4. Boost library headers
5. Libtorrent headers 5. Libtorrent headers
6. Qt 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. 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 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. 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 <QFont> #include <QFont>
#endif #endif
// conditional for the different header groups // conditional that contains headers from several different header groups
#if LIBTORRENT_VERSION_NUM >= 10100 #if LIBTORRENT_VERSION_NUM >= 10100
#include <memory> #include <memory>
#include <QElapsedTimer> #include <QElapsedTimer>
#endif #endif
// qBittorrent own headers // qBittorrent's own headers
#include "base/bittorrent/infohash.h" #include "base/bittorrent/infohash.h"
#include "anothermodule.h" #include "anothermodule.h"
#include "ui_examplewidget.h" #include "ui_examplewidget.h"